Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken #syntax-exceptions link #20541

Merged
merged 5 commits into from
Sep 28, 2022
Merged

Fix broken #syntax-exceptions link #20541

merged 5 commits into from
Sep 28, 2022

Conversation

mLuby
Copy link
Contributor

@mLuby mLuby commented Sep 11, 2022

Why:

Closes #20540

Fixes the link [some exceptions](#syntax-exceptions) from earlier in the doc which currently doesn't go anywhere, since it was broken by the recent change 384473f.

What's being changed (if available, include any code snippets, screenshots, or gifs):

This change re-adds a minor header to the Code owners doc's syntax exceptions warning block so the link to that area will again work as intended.

Note to reviewers: the Preview doesn't render the warning block, so I can't tell if the header conflicts with the non-Markdown warning block.

Existing Header (discarded) Span id (this PR)
existing header span id

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@welcome
Copy link

welcome bot commented Sep 11, 2022

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Sep 11, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 11, 2022

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

Copy link

@ProKashif ProKashif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ✅

@cmwilson21
Copy link
Contributor

@mLuby Thanks for opening a PR and linking to your issue. We also appreciate all the great details you've provided! ✨

Good catch on this one. I'll get it triaged for review! 👀

@cmwilson21
Copy link
Contributor

👋 @mLuby - After looking at this and chatting with the team, I think we would like to see a different approach here. We appreciate your solution, but would like to see this warning box moved to the top of this sub section for better visibility and remove the inline link in question. Would you be up for that?

  1. Remove the , with [some exceptions](#syntax-exceptions) part from line 50, ending the sentence after the word "files".
  2. Move the warning box - lines 120 to 127 - up in this section, right under the CODEOWNERS syntax heading on line 49.

If not, let me know and we will take care of it internally. Thanks again for catching this! ⚡

@cmwilson21 cmwilson21 added more-information-needed More information is needed to complete review and removed triage Do not begin working on this issue until triaged by the team labels Sep 19, 2022
@github-actions
Copy link
Contributor

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Sep 27, 2022
@cmwilson21 cmwilson21 added the ready to merge This pull request is ready to merge label Sep 28, 2022
@docubot docubot added this to Triage in Docs open source board Sep 28, 2022
@cmwilson21
Copy link
Contributor

Thanks for bringing this up and offering your clever fix. I made some tweaks so that it aligned better with our style guide. I'll get this merged once the tests have passed ✅

Thank you for interest in improving the docs! 💛

@cmwilson21 cmwilson21 merged commit 734b504 into github:main Sep 28, 2022
Docs open source board automation moved this from Triage to Done Sep 28, 2022
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@mLuby mLuby deleted the patch-2 branch October 5, 2022 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
more-information-needed More information is needed to complete review ready to merge This pull request is ready to merge stale There is no recent activity on this issue or pull request
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Doc on CODEOWNERS has a broken link for #syntax-expections
5 participants