Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-23 08:58:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 114

Update community.md (#6733)

Browse source 
Added, "How to request a review for Markdown changes to docs."
This commit is contained in:
Mike Thomas 2022-07-19 07:54:30 +09:00 committed by GitHub
parent 101baaf3d5
commit dfe090edd4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
handbook/community.md
View file

@ -92,11 +92,13 @@ Community team members can reach the engineering oncall for assistance by writin
## Fleet docs
### How to request a review for Markdown changes to the docs
When creating a pull request for Markdown changes in the docs, request a review from Desmi Dizney, who will do an editor pass, and then hand over the review to the [on-call engineer](https://fleetdm.com/handbook/engineering#oncall-rotation) if necessary.
### Markdown
Fleet's documentation and handbook are written in [Markdown](https://about.gitlab.com/handbook/markdown-guide/). Using Markdown lets us keep our documentation consistently formatted and viewable directly from the Fleet GitHub repo. The Markdown files in the `/docs` and `/handbook` folders are converted to HTML for the Fleet website.
> **Note** that when you make a Markdown change to any doc you'll want to request the editor, Desmi Dizney for review. For more information see [How to edit Markdown pull requests for the docs](https://fleetdm.com/handbook/brand###how-to-edit-markdown-pull-requests-for-the-docs).
When making changes to the Fleet docs or handbook, there are a few differences in how the Markdown will render on GitHub and the Fleet website.
#### Linebreaks and newlines