docs icon indicating copy to clipboard operation
docs copied to clipboard

Explicitly state that default files don't appear in the file browser or git history

Open GuySartorelli opened this issue 2 years ago â€ĸ 3 comments

The added wording comes from https://github.blog/changelog/2019-02-21-organization-wide-community-health-files/

Why:

This tripped up my team - the documentation as written seemed to imply that the files would be visible in the GitHub file browser. It was only after adding the default files that we learned this wasn't the case. Hopefully having this explicitly stated will help others avoid this misunderstanding.

Closes: #26242

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

Adding an explicit declaration that default health files aren't viewable in individual repositories' file browser or git history to the "Managing Community Health Files...." documentation

Check off the following:

  • [x] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • 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.
  • [x] For content changes, I have completed the self-review checklist.

GuySartorelli avatar Jun 26 '23 04:06 GuySartorelli

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.

welcome[bot] avatar Jun 26 '23 04:06 welcome[bot]

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
communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md fpt
ghec
ghes@ 3.9 3.8 3.7 3.6 3.5
fpt
ghec
ghes@ 3.9 3.8 3.7 3.6 3.5

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

github-actions[bot] avatar Jun 26 '23 04:06 github-actions[bot]

@GuySartorelli Thanks for opening an issue and linking it to your PR! And welcome to the community! 🎉

I'll get this triaged for review! :zap:

In the meantime, if you'd like to find other ways to contribute, check out our help wanted section to find open issues you can work on.

Thank you for your interest in improving GitHub Docs! :sparkling_heart:

cmwilson21 avatar Jun 26 '23 14:06 cmwilson21

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 :zap:

github-actions[bot] avatar Jun 29 '23 17:06 github-actions[bot]

@GuySartorelli 👋 Thanks for adding this to our Docs! This change looks good to me, so I'll go ahead and get this merged ASAP. 🚀

asshole

shawnstowell avatar Aug 21 '23 00:08 shawnstowell