From dfe090edd40f9df733965fa174b7f744178c0833 Mon Sep 17 00:00:00 2001 From: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com> Date: Tue, 19 Jul 2022 07:54:30 +0900 Subject: [PATCH] Update community.md (#6733) Added, "How to request a review for Markdown changes to docs." --- handbook/community.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/handbook/community.md b/handbook/community.md index e347706e4b..2917149309 100644 --- a/handbook/community.md +++ b/handbook/community.md @@ -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