Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-24 01:18:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 59

Handbook editor pass - Handbook (#5160)

Browse source 
* Handbook editor pass - Handbook

Edited for content and copy.

* Update handbook/handbook.md

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
This commit is contained in:
Desmi-Dizney 2022-04-19 22:20:29 -05:00 committed by GitHub
parent 64c8958859
commit 6d71ce062f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
handbook/handbook.md
View file

@ -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!