diff --git a/handbook/README.md b/handbook/README.md index d9a23c1139..f238fe2d29 100644 --- a/handbook/README.md +++ b/handbook/README.md @@ -28,6 +28,8 @@ The Fleet handbook is the central guide for how we run the company. As part of o ### Product +[Feature Flags](./product.md#feature-flags) + [Product DRIs](./product.md#product-dris) [Fleet docs](./product.md#fleet-docs) @@ -50,13 +52,11 @@ The Fleet handbook is the central guide for how we run the company. As part of o [Support process](./customer-experience.md#support-process) -### About the handbook +### Handbook -#### Why bother? -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). +[About the handbook](./handbook.md#about-the-handbook) -#### Where's the rest 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. +[Handbook styleguide](./handbook.md#handbook-styleguide) diff --git a/handbook/handbook.md b/handbook/handbook.md new file mode 100644 index 0000000000..752951419b --- /dev/null +++ b/handbook/handbook.md @@ -0,0 +1,27 @@ +# Handbook + +## 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). + +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. + +## Handbook styleguide + +### Headings + +Headings help readers scan content to easily find what they need. Organize page content using clear headings, specific to the topic they describe. + +Keep headings brief and organize them in a logical order: + +* H1: Page title +* H2: Main headings +* H3: Subheadings +* H4: Sub-subheadings (headings nested under subheadings) + +Try to stay within 3 or 4 heading levels. Complicated documents may use more, but pages with a simpler structure are easier to read. + + + + + \ No newline at end of file diff --git a/handbook/product.md b/handbook/product.md index 6a4fd5e75c..705eef1ec7 100644 --- a/handbook/product.md +++ b/handbook/product.md @@ -14,6 +14,21 @@ Fleet's feature flag guidelines borrows from GitLab's ["When to use feature flag ## Fleet docs +### Docs styleguide + +#### Headings + +Headings help readers scan content to easily find what they need. Organize page content using clear headings, specific to the topic they describe. + +Keep headings brief and organize them in a logical order: + +* H1: Page title +* H2: Main headings +* H3: Subheadings +* H4: Sub-subheadings (headings nested under subheadings) + +Try to stay within 3 or 4 heading levels. Complicated documents may use more, but pages with a simpler structure are easier to read. + ### Adding a link to the Fleet docs You can link documentation pages to each other using relative paths. For example, in `docs/01-Using-Fleet/01-Fleet-UI.md`, you can link to `docs/01-Using-Fleet/09-Permissions.md` by writing `[permissions](./09-Permissions.md)`. This will be automatically transformed into the appropriate URL for `fleetdm.com/docs`.