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

Added links to docs: for words that mention organizations and authen… #35541

Closed
wants to merge 1 commit into from

Conversation

zufichris
Copy link

…tication

for example [organizations](Link that leads to github documentation for organizations)

Why:

Closes:

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

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing.

…ication

for example [organizations](Link that leads to github  documentation for organizations)
Copy link

welcome bot commented Dec 3, 2024

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 Dec 3, 2024
Copy link
Contributor

github-actions bot commented Dec 3, 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
apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 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 waiting for review Issue/PR is waiting for a writer's review github apps Content related to GitHub Apps and removed triage Do not begin working on this issue until triaged by the team labels Dec 3, 2024
@nguyenalex836
Copy link
Contributor

@zufichris Thanks so much for opening a PR! I'll get this triaged for review ✨ In the meantime, I wanted to provide a link to our style guide just for reference 💛

@subatoi
Copy link
Contributor

subatoi commented Dec 4, 2024

@zufichris Thanks for raising a PR and your interest in the docs 👋

Unfortunately, we can't accept this submission for the following reasons:

  • It doesn't conform to the style guide in terms of sentence casing and the use of AUTOTITLE (see https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide)
  • It's not clear exactly what benefit the changes would provide, other than the additional links. Travel between our different pages is something we're constantly reviewing, and we'd generally only make changes if there was a very clear user trend indicating a need for that. In this case there isn't

I'd generally recommend opening an issue first, so we can validate proposed changes before you raise them and everyone—most importantly, you—has a better experience. In the meantime, you can always have a look at our issues marked help wanted. Thank you!

@subatoi subatoi closed this Dec 4, 2024
@github github deleted a comment from Sahebi62 Dec 4, 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 github apps Content related to GitHub Apps 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.

3 participants