Closes: #12611
Changes:
- Added three new documentation sections `/docs/get-started/`,
`/docs/configuration` and `/docs/rest api/`
- Updated folder names: `/docs/Using-Fleet/` » `/docs/Using Fleet` and
`/docs/deploying` » `/docs/deploy/`
- Moved `/docs/using-fleet/process-events.md` to `/articles` and updated
the meta tags to change it into a guide.
- Added support for a new meta tag: `navSection`. This meta tag is used
to organize pages in the sidebar navigation on fleetdm.com/docs
- Moved `docs/using-fleet/application-security.md` and
`docs/using-fleet/security-audits.md` to the security handbook.
- Moved `docs/deploying/load-testing.md` and
`docs/deploying/debugging.md` to the engineering handbook.
- Moved the following files/folders:
- `docs/using-fleet/configuration-files/` »
`docs/configuration/configuration-files/`
- `docs/deploying/configuration.md` »
`docs/configuration/fleet-server-configuration.md`
- `docs/using-fleet/rest-api.md` » `docs/rest-api/rest-api.md`
- `docs/using-fleet/monitoring-fleet.md` » `docs/deploy/rest-api.md`
- Updated filenames:
- `docs/using-fleet/permissions.md` »
`docs/using-fleet/manage-access.md`
- `docs/using-fleet/adding-hosts.md` »
`docs/using-fleet/enroll-hosts.md`
- `docs/using-fleet/teams.md` » `docs/using-fleet/segment-hosts.md`
- `docs/using-fleet/fleet-ctl-agent-updates.md` »
`docs/using-fleet/update-agents.md`
- `docs/using-fleet/chromeos.md` »
`docs/using-fleet/enroll-chromebooks.md`
- Updated the generated markdown in `server/fleet/gen_activity_doc.go`
and `server/service/osquery_utils/gen_queries_doc.go`
- Updated the navigation sidebar and mobile dropdown links on docs pages
to group pages by their `navSection` meta tag.
- Updated fleetdm.com/docs not to show pages in the `docs/contributing/`
folder in the sidebar navigation
- Added redirects for docs pages that have moved.
.
---------
Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
https://github.com/fleetdm/confidential/issues/3146
To test this works:
- sam should be able to change ceo handbook and be autoapproved
- mike submitting a PR to the ceo handbook should request review from
Sam but auto-approve for mike
- Jarod's use case of creating an article should now work, even if his
PR contains images
.
---------
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
- Update sentence case section in the handbook to clarify that role
names and features in the Fleet product are not proper nouns and thus
shouldn't be capitalized
- Update one spot in the Fleet UI to reflect this
closes: #11758
Changes:
- Moved the sentence case section from the content style guide to the
"Why this way?" page.
...
---------
Co-authored-by: Sampfluger88 <108141731+Sampfluger88@users.noreply.github.com>
Add clarification about what "packs" are and why they aren't considered
deprecated in spite of removing the "Packs" section of the UI.
This is a modified version of [an
answer](https://osquery.slack.com/archives/C01DXJL16D8/p1685473347649069?thread_ts=1685447394.383489&cid=C01DXJL16D8)
@mikermcneil posted in the osquery slack. I trimmed a little bit of the
content in hopes of making this clearer (namely the specific list of
improvements that led to removing the "Packs" UI) but if you think that
context is too important to leave out I'll include it here.
.
---------
Co-authored-by: Sampfluger88 <108141731+Sampfluger88@users.noreply.github.com>
Adding marketing experimentation guidelines to handbook
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
---------
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
Moved sales paragraph onto 'Why this way' page in the same heading
format including the 'cold-outbound-strategy' URL (I can't figure out
how to edit URL text so it says 'Our sales strategy')
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
# Checklist for submitter
If some of the following don't apply, delete the relevant line.
- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
* Update why-this-way.md
These edits address items 6 and 9 from the handbook notes doc: https://docs.google.com/document/d/17BhgTqCI5255RY71m5ri3nDx71DqmfYwyJmRe_nJ4Ns/edit?usp=sharing.
The content for Why open source? identifies benefits and addresses security concerns. I ended this section with a sort of call to action. This differs from other content in Why this way, but it seemed like a good opportunity. If this feels too aggressive, I can cut the Results section.
I've consolidated the bullets for every company values, as well as wrote summaries for the values that didn't have them. The goal is to make each value more distinct and easier to understand.
* Update README.md
* Update README.md
* Handbook: Openness value
adding the Q&A session to the "why this way" page
* Update handbook/company/why-this-way.md
Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com>
* Update why-this-way.md
I revised the copy Charlie provided for two main reasons.
First, to keep formatting on the page consistent by removing the Q&A framework.
Second, to apply Mike's rationale from the Slack conversation to speak about Openness more broadly. People who find this section won't have the Slack conversation for context. Stepping back a bit will make this more approachable. However, I'm happy to add more detail if necessary.
Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com>
* Create why-this-way.md
Moved "Why this way" to it's own page within Company handbook.
* Create development-groups.md
Added new page development-groups.md to Company handbook.
* Update README.md
Added space for Charlie to write summary for our new sections and add links to the nested pages.
* Update development-groups.md
Added meta tags to the page.
* Update why-this-way.md
* Update why-this-way.md
Changed head hierarchy to populate sub nav.
* preamble and links to sub pages
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
