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: revise link and improve information about topics in the contributing docs #34491

Merged
merged 11 commits into from
Sep 5, 2024

Conversation

CBID2
Copy link
Contributor

@CBID2 CBID2 commented Sep 4, 2024

Why:

This PR changes the link in the first paragraph in The "About Topics" article as well as adding an example on how to arrange the titles in frontmatter. Doing this would help contributors gain a better idea of how to contribute to GitHub's documentation.

Closes:

Closes #34378

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

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Sep 4, 2024
@CBID2 CBID2 marked this pull request as ready for review September 4, 2024 17:25
Signed-off-by: Christine <[email protected]>
Copy link
Contributor

github-actions bot commented Sep 4, 2024

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
contributing/style-guide-and-content-model/about-topics.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

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

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Sep 4, 2024
@nguyenalex836
Copy link
Contributor

@CBID2 Thank you for opening this PR! ✨ While we wait for guidance on the Markdown error, I'll triage this for a writer to review the content you've added 💛

@nguyenalex836
Copy link
Contributor

@CBID2 I made a few minor updates regarding a run-on sentence and changing the phrase "Here's an example" to "For example" per guidance from our writers 💛 I'll update the branch and get this merged once tests are passing 🍏

Thank you again for opening this PR! ✨

@nguyenalex836 nguyenalex836 added this pull request to the merge queue Sep 5, 2024
Merged via the queue into github:main with commit 1c69432 Sep 5, 2024
46 checks passed
Copy link
Contributor

github-actions bot commented Sep 5, 2024

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

@CBID2 CBID2 deleted the fixing-information-in-about-topics branch September 5, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix link and improve information about topics in the contributing docs
2 participants