Skip to content

Conversation

@CBID2
Copy link
Contributor

@CBID2 CBID2 commented Feb 29, 2024

Why:

Closes: #31686

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

This PR adds examples of how not to write content in GitHub's documentation to their style guide.

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.

Signed-off-by: Christine <shecoder30@gmail.com>
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 29, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Feb 29, 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/style-guide.md fpt
ghec
ghes@ 3.12 3.11 3.10 3.9 3.8
fpt
ghec
ghes@ 3.12 3.11 3.10 3.9 3.8

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 waiting for review Issue/PR is waiting for a writer's review labels Feb 29, 2024
@nguyenalex836
Copy link
Contributor

Howdy, @CBID2 👋 ! It looks like you've asked @ethanpalm for assistance on the related issue. I'll go ahead and leaves this PR for now while we wait for his input 💛 thank you for taking this on!

@CBID2
Copy link
Contributor Author

CBID2 commented Feb 29, 2024

Howdy, @CBID2 👋 ! It looks like you've asked @ethanpalm for assistance on the related issue. I'll go ahead and leaves this PR for now while we wait for his input 💛 thank you for taking this on!

Thanks @nguyenalex836. You can give feedback too! :) I'm open to your thoughts

@nguyenalex836
Copy link
Contributor

Howdy, @CBID2 👋 ! It looks like you've asked @ethanpalm for assistance on the related issue. I'll go ahead and leaves this PR for now while we wait for his input 💛 thank you for taking this on!

Thanks @nguyenalex836. You can give feedback too! :) I'm open to your thoughts

That's very kind of you! 😊 This isn't my area of expertise, and Ethan will be the superior resource - but I appreciate the kind words! 💛

Copy link
Contributor

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

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

Thanks for creating this PR, @CBID2! Adding this example is helpful since it's a pretty common mixup.

The other changes to close #31686 would be updating lines 1482 and 1483 (unfortunately they're too far from the edited lines so I can't put the comments directly on those lines).

1482: change "Write" to write and "Admin" to admin so that the line reads (e.g. write for a repository, admin for a security advisory)
1483: remove the quotation marks so "team maintainer" becomes team maintainer

@CBID2
Copy link
Contributor Author

CBID2 commented Mar 1, 2024

write and "Admin"

Hi @ethanpalm. I made the changes.

ethanpalm
ethanpalm previously approved these changes Mar 1, 2024
Copy link
Contributor

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

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

This looks great, @CBID2 😄

I'm going to push one small change to remove the quotation marks around write and admin, then will get this published. It should be live on the Docs site soon.

Thank you for taking the time to help improve the GitHub Docs! 🚀

@ethanpalm ethanpalm enabled auto-merge March 1, 2024 16:28
@ethanpalm ethanpalm added this pull request to the merge queue Mar 1, 2024
Merged via the queue into github:main with commit 5aa53a5 Mar 1, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Mar 1, 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 improving-the-style-guide branch March 1, 2024 17:16
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Style guide for access, permission, role names and its usage unclear

3 participants