Add headings styleguide to handbook (#3460)

* added instructions for how to use headings for the handbook and Fleet docs.
* Also added "Feature flags" section link to README.md
This commit is contained in:
Mike Thomas 2021-12-22 20:09:28 +09:00 committed by GitHub
parent 54cbbee9cd
commit b030315c55
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 47 additions and 5 deletions

View file

@ -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)
<meta name="maintainedBy" value="mikermcneil">

27
handbook/handbook.md Normal file
View file

@ -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.
<meta name="maintainedBy" value="mike-j-thomas">

View file

@ -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`.