diff --git a/handbook/handbook.md b/handbook/handbook.md index 9b9b7ed744..c934b874e5 100644 --- a/handbook/handbook.md +++ b/handbook/handbook.md @@ -2,15 +2,15 @@ ## About the handbook -The Fleet handbook is inspired by (and heavily influenced by) the [GitLab team handbook](https://about.gitlab.com/handbook/about/). It shares the same [advantages](https://about.gitlab.com/handbook/about/#advantages) and will probably undergo a similar [evolution](https://about.gitlab.com/handbook/ceo/#evolution-of-the-handbook). +The Fleet handbook is inspired by the [GitLab team handbook](https://about.gitlab.com/handbook/about/). It shares the same [advantages](https://about.gitlab.com/handbook/about/#advantages) and will probably undergo a similar [evolution](https://about.gitlab.com/handbook/ceo/#evolution-of-the-handbook). -While this handbook is inspired by [GitLab's handbook](https://about.gitlab.com/handbook/), it is nowhere near as complete (yet!) We will continue to add and update information in this handbook, and gradually migrate information from [Fleet's shared Google Drive folder](https://drive.google.com/drive/u/0/folders/1StSOI3HNcsl9VleXxNWfUBT2co7h44OG) as time allows. +While [GitLab's handbook](https://about.gitlab.com/handbook/) inspires this handbook, it is nowhere near as complete (yet!) We will continue adding and updating this handbook and gradually migrating information from [Fleet's shared Google Drive folder](https://drive.google.com/drive/u/0/folders/1StSOI3HNcsl9VleXxNWfUBT2co7h44OG) as time allows. ## Handbook style guide ### Headings -Headings help readers scan content to easily find what they need. Organize page content using clear headings, specific to the topic they describe. +Headings help readers scan content to find what they need easily. Organize page content using clear headings specific to the topic they describe. Keep headings brief and organize them in a logical order: @@ -24,11 +24,11 @@ Try to stay within 3 or 4 heading levels. Complicated documents may use more, bu ## Contributing to the handbook To contribute to a handbook page: -1. Click "Edit this page" -2. Make your changes in the browser. (The language is [markdown](https://github.github.com/gfm/).) -3. Click "Propose changes" -4. Request a reviewer by clicking the gear and picking only one. Choose the reviewer whose face is on the handbook page when you view it on fleetdm.com -5. Click "Create pull request". +1. Click "Edit this page." +2. Make your changes in the browser(The language is [Markdown](https://github.github.com/gfm/)). +3. Click "Propose changes." +4. Request a reviewer by clicking the gear and picking only one. Choose the reviewer whose face is on the handbook page when you view it on fleetdm.com. +5. Click "Create pull request." All done!