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 link #34380

Conversation

gagan-bhullar-tech
Copy link
Contributor

@gagan-bhullar-tech gagan-bhullar-tech commented Aug 22, 2024

Why:

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 Aug 22, 2024
Copy link
Contributor

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
Copy link
Contributor

@gagan-bhullar-tech Thank you for opening this PR! ✨ In your PR, are you able to update to address the rest of the points the linked issue is raising?

However, there is also scope to clarify what topics are and how they are defined in Markdown. The first paragraph of the article could be rewritten to explain that an article can be defined as being relevant to one or more topics by having those topics listed in the article's frontmatter - i.e. the metadata at the top of an article's Markdown file.

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team contributing docs Content related to our contributing docs 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 Aug 22, 2024
@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Aug 29, 2024
Copy link
Contributor

This PR has been automatically closed because there has been no response to to our request for more information from the original author. Please reach out if you have the information we requested, or open a new issue to describing your changes. Then we can begin the review process.

@github-actions github-actions bot closed this Aug 29, 2024
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 more-information-needed More information is needed to complete review stale There is no recent activity on this issue or pull request
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