Clean up "click here" and "here" link anchors - part 1 (#29731)

Fixes part of #29720.. Includes promoting some bolded to subheadings (in
wireframe docs).

---------

Co-authored-by: Sam Pfluger <108141731+Sampfluger88@users.noreply.github.com>
This commit is contained in:
Ian Littman 2025-06-04 13:54:34 -06:00 committed by GitHub
parent 17f41b1147
commit ddd7891939
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 48 additions and 57 deletions

View file

@ -4440,7 +4440,7 @@ Fleet server in non-debug mode.
* Fixed a bug in which live queries would fail for deployments that use Redis Cluster. * Fixed a bug in which live queries would fail for deployments that use Redis Cluster.
* Fixed a bug in which some new Fleet deployments don't include the default global agent options. Documentation for global and team agent options can be found [here](https://fleetdm.com/docs/using-fleet/configuration-files#agent-options). * Fixed a bug in which some new Fleet deployments don't include the default global [agent options](https://fleetdm.com/docs/using-fleet/configuration-files#agent-options).
* Improved how a host's `users` are stored in MySQL to prevent deadlocks. This information is available in the "Users" table on each host's **Host details** page and in the `GET /api/v1/fleet/hosts/{id}` API route. * Improved how a host's `users` are stored in MySQL to prevent deadlocks. This information is available in the "Users" table on each host's **Host details** page and in the `GET /api/v1/fleet/hosts/{id}` API route.
@ -4632,7 +4632,7 @@ Fleet 4.0.0 is a major release and introduces several breaking changes and datab
* The `username` artifact has been removed in favor of the more recognizable `name` (Full name). As a result the `email` artifact is now used for uniqueness in Fleet. Upon upgrading to Fleet 4.0.0, existing users will have the `name` field populated with `username`. SAML users may need to update their username mapping to match user emails. * The `username` artifact has been removed in favor of the more recognizable `name` (Full name). As a result the `email` artifact is now used for uniqueness in Fleet. Upon upgrading to Fleet 4.0.0, existing users will have the `name` field populated with `username`. SAML users may need to update their username mapping to match user emails.
* As of Fleet 4.0.0, Fleet Device Management Inc. periodically collects anonymous information about your instance. Sending usage statistics is turned off by default for users upgrading from a previous version of Fleet. Read more about the exact information collected [here](https://github.com/fleetdm/fleet/blob/2f42c281f98e39a72ab4a5125ecd26d303a16a6b/docs/1-Using-Fleet/11-Usage-statistics.md). * As of Fleet 4.0.0, Fleet Device Management Inc. periodically collects [anonymous information about your instance](https://github.com/fleetdm/fleet/blob/2f42c281f98e39a72ab4a5125ecd26d303a16a6b/docs/1-Using-Fleet/11-Usage-statistics.md). Sending usage statistics is turned off by default for users upgrading from a previous version of Fleet.
## Fleet 4.0.0 RC3 (Jun 25, 2021) ## Fleet 4.0.0 RC3 (Jun 25, 2021)
@ -4737,7 +4737,7 @@ Fleet 4.0.0 is a major release and introduces several breaking changes and datab
## Fleet 3.13.0 (Jun 3, 2021) ## Fleet 3.13.0 (Jun 3, 2021)
* Improved performance of the `additional_queries` feature by moving `additional` query results into a separate table in the MySQL database. Please note that the `/api/v1/fleet/hosts` API endpoint now return only the requested `additional` columns. See documentation on the changes to the hosts API endpoint [here](https://github.com/fleetdm/fleet/blob/06b2e564e657492bfbc647e07eb49fd4efca5a03/docs/1-Using-Fleet/3-REST-API.md#list-hosts). * Improved performance of the `additional_queries` feature by moving `additional` query results into a separate table in the MySQL database. Please note that the [`/api/v1/fleet/hosts` API endpoint](https://github.com/fleetdm/fleet/blob/06b2e564e657492bfbc647e07eb49fd4efca5a03/docs/1-Using-Fleet/3-REST-API.md#list-hosts) now only returns the requested `additional` columns.
* Fixed a bug in which running a live query in the Fleet UI would return no results and the query would seem "hung" on a small number of devices. * Fixed a bug in which running a live query in the Fleet UI would return no results and the query would seem "hung" on a small number of devices.

View file

@ -574,8 +574,8 @@ We use `<meta>` tags in Markdown articles to set metadata information about the
The [Audit logs doc page](https://fleetdm.com/docs/Using-Fleet/Audit-logs) has a page generator that is used to speed up doc writing when Fleet adds new activity types. The [Audit logs doc page](https://fleetdm.com/docs/Using-Fleet/Audit-logs) has a page generator that is used to speed up doc writing when Fleet adds new activity types.
- If you're making a copy change to an exiting activity type, edit the `activities.go` file [here](https://github.com/fleetdm/fleet/blob/main/server/fleet/activities.go). - If you're making a copy change to an exiting activity type, [edit the `activities.go` file](https://github.com/fleetdm/fleet/blob/main/server/fleet/activities.go).
- If you're making a change to the top section or meta tags, edit the `gen_activity_doc.go` file [here](https://github.com/fleetdm/fleet/blob/main/server/fleet/gen_activity_doc.go). - If you're making a change to the top section or meta tags, [edit the `gen_activity_doc.go` file](https://github.com/fleetdm/fleet/blob/main/server/fleet/gen_activity_doc.go).
- If you're adding a new activity type, add the activity to the `ActivityDetailsList` list in the `activities.go` file. - If you're adding a new activity type, add the activity to the `ActivityDetailsList` list in the `activities.go` file.
After making your changes, save them and run `make generate-doc`. This will generate a new `Audit-logs.md` file. Make sure you run the command in the top level folder of your cloned, Fleet repo. After making your changes, save them and run `make generate-doc`. This will generate a new `Audit-logs.md` file. Make sure you run the command in the top level folder of your cloned, Fleet repo.
@ -943,7 +943,7 @@ Learn how to communicate as Fleet with guidelines for tone of voice, our approac
Dont duplicate content. Link to existing places like the [values](https://fleetdm.com/handbook/company#values) or [“why this way”](https://fleetdm.com/handbook/company/why-this-way#why-this-way), but dont make it awkward. Linking to existing material when something comes up is a gentle way to remind and train using the foundation we've already built. Dont duplicate content. Link to existing places like the [values](https://fleetdm.com/handbook/company#values) or [“why this way”](https://fleetdm.com/handbook/company/why-this-way#why-this-way), but dont make it awkward. Linking to existing material when something comes up is a gentle way to remind and train using the foundation we've already built.
Create headings that make good permalinks, use links and add missing links. Don't anchor links with `[here]` or `[click here]`; [linking relevant words is better for accessibility](https://granicus.com/blog/why-click-here-links-are-bad/) and better for SEO. Create headings that make good permalinks, use links and add missing links. Don't anchor links with "here" or "click here"; [linking relevant words is better for accessibility](https://granicus.com/blog/why-click-here-links-are-bad/) and better for SEO.
### What would Mister Rogers say? ### What would Mister Rogers say?

View file

@ -253,7 +253,7 @@ Anyone in the product group can initiate an air guitar session.
Please read carefully and [pay special attention](https://fleetdm.com/handbook/company/why-this-way#why-do-we-use-a-wireframe-first-approach) to UI wireframes. Please read carefully and [pay special attention](https://fleetdm.com/handbook/company/why-this-way#why-do-we-use-a-wireframe-first-approach) to UI wireframes.
While Product Designers are responsible for wireframing significant UI changes at Fleet's breakpoints (see breakpoints in the user story template [here](https://github.com/fleetdm/fleet/blob/main/.github/ISSUE_TEMPLATE/story.md)), Fleet relies on Engineers to fill in the gaps and fluidly include all screen widths. If you discovered a gap, please bring the proposed changes as a live prototype to your product group's next design review. While Product Designers are responsible for wireframing significant UI changes at Fleet's breakpoints (see [breakpoints in the user story template](https://github.com/fleetdm/fleet/blob/main/.github/ISSUE_TEMPLATE/story.md)), Fleet relies on Engineers to fill in the gaps and fluidly include all screen widths. If you discovered a gap, please bring the proposed changes as a live prototype to your product group's next design review.
Designs have usually gone through multiple rounds of revisions, but they could easily still be overlooking complexities or edge cases! When you think you've discovered a blocker, here's how to proceed: Designs have usually gone through multiple rounds of revisions, but they could easily still be overlooking complexities or edge cases! When you think you've discovered a blocker, here's how to proceed:
@ -540,7 +540,7 @@ The on-call developer is asked to read, understand, test, correct, and improve a
Our goal is to ensure accuracy and verify that our deployment guides and tutorials are up to date and work as expected, as well as improve the readability, consistency, and simplicity of our documentation with empathy towards first-time users. Our goal is to ensure accuracy and verify that our deployment guides and tutorials are up to date and work as expected, as well as improve the readability, consistency, and simplicity of our documentation with empathy towards first-time users.
See [Writing documentation](https://fleetdm.com/handbook/marketing#writing-documentation) for writing guidelines, and don't hesitate to reach out to [#g-digital-experience](https://fleetdm.slack.com/archives/C01GQUZ91TN) on Slack for writing support. A backlog of documentation improvement needs is kept [here](https://github.com/fleetdm/fleet/issues?q=is%3Aopen+is%3Aissue+label%3A%22%3Aimprove+documentation%22). See [Writing documentation](https://fleetdm.com/handbook/marketing#writing-documentation) for writing guidelines, and don't hesitate to reach out to [#g-digital-experience](https://fleetdm.slack.com/archives/C01GQUZ91TN) on Slack for writing support. [Outstanding documentation issues](https://github.com/fleetdm/fleet/issues?q=is%3Aopen+is%3Aissue+label%3A%22%3Aimprove+documentation%22) use the `:improve documentation` tag.
- **Engineering alerts** - **Engineering alerts**
The on-call developer is responsible for triaging new alerts in the #help-engineering Slack channel, such as failing unit tests. If the on-call developer has the ability to make the fix, they should do so. Otherwise, they should request help from the appropriate team. Filing a bug is also an option if the issue is not urgent. The on-call developer is responsible for triaging new alerts in the #help-engineering Slack channel, such as failing unit tests. If the on-call developer has the ability to make the fix, they should do so. Otherwise, they should request help from the appropriate team. Filing a bug is also an option if the issue is not urgent.
@ -583,33 +583,33 @@ In the Slack reminder thread, the on-call developer includes their retrospective
We have certain design conventions that we include in Fleet. We will document more of these over time. We have certain design conventions that we include in Fleet. We will document more of these over time.
**Design system** ### Design system
The 🧩 ["Design System"](https://www.figma.com/file/8oXlYXpgCV1Sn4ek7OworP/%F0%9F%A7%A9-Design-System-(current)?type=design&mode=design&t=BytcobQwypszkxf5-1) component library in Figma is the source of truth for components. Components in the product (documented in [Storybook](https://fleetdm.com/storybook/)) should match the style of components defined in the Figma library. If the frontend component is inconsistent with one in the Figma library, treat that as a [bug](https://fleetdm.com/handbook/engineering#finding-bugs). As new components are being created, or existing components are being updated, ensure updates are applied to both the Figma Library and Storybook and guidelines are documented in Figma. The 🧩 ["Design System"](https://www.figma.com/file/8oXlYXpgCV1Sn4ek7OworP/%F0%9F%A7%A9-Design-System-(current)?type=design&mode=design&t=BytcobQwypszkxf5-1) component library in Figma is the source of truth for components. Components in the product (documented in [Storybook](https://fleetdm.com/storybook/)) should match the style of components defined in the Figma library. If the frontend component is inconsistent with one in the Figma library, treat that as a [bug](https://fleetdm.com/handbook/engineering#finding-bugs). As new components are being created, or existing components are being updated, ensure updates are applied to both the Figma Library and Storybook and guidelines are documented in Figma.
**Table empty states** ### Table empty states
Use `---`, with color `$ui-fleet-black-50` as the default UI for empty columns. Use `---`, with color `$ui-fleet-black-50` as the default UI for empty columns.
**Images** ### Images
Simple icons (aka any images used in the icon [design system component](https://www.figma.com/design/8oXlYXpgCV1Sn4ek7OworP/%F0%9F%A7%A9-Design-system-(current)?node-id=12-2&t=iO2vXbQ9Sc1kFVEJ-1)) are exported as SVGs. All other images are exported as PNGs, following the [Fleet website image](https://github.com/fleetdm/fleet/tree/main/website/assets/images) naming conventions. Simple icons (aka any images used in the icon [design system component](https://www.figma.com/design/8oXlYXpgCV1Sn4ek7OworP/%F0%9F%A7%A9-Design-system-(current)?node-id=12-2&t=iO2vXbQ9Sc1kFVEJ-1)) are exported as SVGs. All other images are exported as PNGs, following the [Fleet website image](https://github.com/fleetdm/fleet/tree/main/website/assets/images) naming conventions.
**Form behavior** ### Form behavior
Pressing the return or enter key with an open form will cause the form to be submitted. Pressing the return or enter key with an open form will cause the form to be submitted.
**Internal links** ### Internal links
For text links that navigate the user to a different page within the Fleet UI, use the `$core-blue` color and `xs-bold` styling. You'll also want to make sure to use the underline style for when the user hovers over these links. For text links that navigate the user to a different page within the Fleet UI, use the `$core-blue` color and `xs-bold` styling. You'll also want to make sure to use the underline style for when the user hovers over these links.
**External links** ### External links
For a link that navigates the user to an external site (e.g., fleetdm.com/docs), use the `$core-blue` color and `xs-bold` styling for the link's text. Also, place the link-out icon to the right of the link's text. For a link that navigates the user to an external site (e.g., fleetdm.com/docs), use the `$core-blue` color and `xs-bold` styling for the link's text. Also, place the link-out icon to the right of the link's text.
When including an external link, specify a [redirect on fleetdm.com](https://github.com/fleetdm/fleet/blob/7b751fa50a9a7f81112c5e65334ab05fa2e9e216/website/config/routes.js#L491-L518) rather than the original link. That way, if the URL changes, we can fix it immediately via a PR to the website and users will not need to upgrade to benefit from the fix. Once the design is settled, make a PR for the redirect as part of preparing the story for development. When including an external link, specify a [redirect on fleetdm.com](https://github.com/fleetdm/fleet/blob/7b751fa50a9a7f81112c5e65334ab05fa2e9e216/website/config/routes.js#L491-L518) rather than the original link. That way, if the URL changes, we can fix it immediately via a PR to the website and users will not need to upgrade to benefit from the fix. Once the design is settled, make a PR for the redirect as part of preparing the story for development.
**Tooltips** ### Tooltips
All tooltips change the cursor to a question mark on hover. All tooltips have a solid background color. All tooltips change the cursor to a question mark on hover. All tooltips have a solid background color.
@ -619,29 +619,29 @@ There are two types of tooltips. The two types of tooltips have some unique styl
2. Tooltips for buttons, bubbles, table row elements, and other non-text elements appear when hovering over the element. These tooltips use center-aligned text. These tooltips include a centered arrow. 2. Tooltips for buttons, bubbles, table row elements, and other non-text elements appear when hovering over the element. These tooltips use center-aligned text. These tooltips include a centered arrow.
**Bold text** ### Bold text
For copy in the Fleet UI and Fleet documentation, use bold text when referencing UI elements such as buttons, links, column names, form field names, page names, and section names. For an example, check out the bold text in the docs [here](https://fleetdm.com/docs/using-fleet/mdm-disk-encryption#step-1-enforce-disk-encryption). For copy in the Fleet UI and Fleet documentation, use bold text when referencing UI elements such as buttons, links, column names, form field names, page names, and section names. For an example, check out the bold text in the [guide on enforcing disk encryption](https://fleetdm.com/docs/using-fleet/mdm-disk-encryption#step-1-enforce-disk-encryption).
This way, if a user is scanning instructions, the bold text tells them what UI element they should look for. This way, if a user is scanning instructions, the bold text tells them what UI element they should look for.
In the docs, if a UI element is part of a section title (already bold) use double quotes. For an example, see this section title [here](https://fleetdm.com/docs/get-started/faq#what-happened-to-the-schedule-page). In the docs, if a UI element is part of a section title (already bold) use double quotes, as shown in the [explanation of MDM on/off in "Why this way"](https://fleetdm.com/handbook/company/why-this-way#why-does-fleet-use-mdm-on-off-instead-of-mdm-enrolled-unenrolled).
**Copy in parentheses (additional information)** ### Copy in parentheses (additional information)
When writing copy, consider whether additional information is necessary before adding it as a new sentence or in parentheses. If the information is needed, use parentheses with an incomplete sentence to keep the copy shorter. When writing copy, consider whether additional information is necessary before adding it as a new sentence or in parentheses. If the information is needed, use parentheses with an incomplete sentence to keep the copy shorter.
**Writing the time** ### Writing the time
When writing the time in the UI using "am" and "pm" abbreviations, write them **without space** between time and abbreviation, with **no punctuation**, and use **lowercase** letters (e.g. Working hours are 8am to 5pm). When writing the time in the UI using "am" and "pm" abbreviations, write them **without space** between time and abbreviation, with **no punctuation**, and use **lowercase** letters (e.g. Working hours are 8am to 5pm).
**Writing error messages** ### Writing error messages
When writing error messages in the UI or CLI, follow these rules: When writing error messages in the UI or CLI, follow these rules:
- If the solution to the error isn't obvious, write a message with the **error** followed by the **solution**. For example, "No hosts targeted. Make sure you provide a valid hostname, UUID, osquery host ID, or node key." - If the solution to the error isn't obvious, write a message with the **error** followed by the **solution**. For example, "No hosts targeted. Make sure you provide a valid hostname, UUID, osquery host ID, or node key."
- If the solution is obvious when additional info is provided, write a message with the **error** followed by **additional info**. For example, "You dont have permission to run the script. Only users with the maintainer role and above can run scripts." - If the solution is obvious when additional info is provided, write a message with the **error** followed by **additional info**. For example, "You dont have permission to run the script. Only users with the maintainer role and above can run scripts."
**Fleetctl commands with `--hosts` or `--host` flag** ### Fleetctl commands with `--hosts` or `--host` flag
When designing CLI experience for commands that target hosts (e.g. `fleetctl query` or `fleetctl mdm run-command` when including the `--hosts` or `--host` flag), if a non-existing host is specified, use a single error message such as: `Error: No hosts targeted. Make sure you provide a valid hostname, UUID, osquery host ID, or node key.` When designing CLI experience for commands that target hosts (e.g. `fleetctl query` or `fleetctl mdm run-command` when including the `--hosts` or `--host` flag), if a non-existing host is specified, use a single error message such as: `Error: No hosts targeted. Make sure you provide a valid hostname, UUID, osquery host ID, or node key.`

View file

@ -330,9 +330,9 @@ You can confirm that the device has been ordered correctly by following these st
- View device settings and ensure the "MDM Server" selected is "Fleet Dogfood". - View device settings and ensure the "MDM Server" selected is "Fleet Dogfood".
On occasion there will be a need to manually enroll a macOS host in dogfood. This could be due to a BYOD arrangement, or because the Fleetie getting the device is in a country when DEP (automatic enrollment) isn't supported. To manually enroll a macOS host in dogfood, follow these steps: On occasion there will be a need to manually enroll a macOS host in dogfood. This could be due to a BYOD arrangement, or because the Fleetie getting the device is in a country when DEP (automatic enrollment) isn't supported. To manually enroll a macOS host in dogfood, follow these steps:
- If you have physical access to the macOS host, use Apple Configurator (docs are [here](https://support.apple.com/guide/apple-business-manager/add-devices-from-apple-configurator-axm200a54d59/web)). - If you have physical access to the macOS host, [add it via Apple Configurator](https://support.apple.com/guide/apple-business-manager/add-devices-from-apple-configurator-axm200a54d59/web).
- If you do not have physical access to the device, the user will need to undertake the following steps: - If you do not have physical access to the device, the user will need to undertake the following steps:
- Install the fleetd package for your device from shared drive folder [here](https://drive.google.com/drive/folders/1-hMwk4P7NRzCU5kDxkEcOo8Sluuaux1h?usp=drive_link). - Install the fleetd package for your device from the [shared drive folder](https://drive.google.com/drive/folders/1-hMwk4P7NRzCU5kDxkEcOo8Sluuaux1h?usp=drive_link).
- Once fleetd is installed, click on Fleet desktop icon in top right menu bar, and select "My device". - Once fleetd is installed, click on Fleet desktop icon in top right menu bar, and select "My device".
- In Fleet desktop, follow the instructions to turn on MDM. - In Fleet desktop, follow the instructions to turn on MDM.
- Once complete, follow instructions to reset disk encryption key. - Once complete, follow instructions to reset disk encryption key.
@ -341,7 +341,7 @@ On occasion there will be a need to manually enroll a macOS host in dogfood. Thi
### Enroll a Windows or Ubuntu Linux device in dogfood ### Enroll a Windows or Ubuntu Linux device in dogfood
To enroll a windows or Ubuntu Linux device in dogfood, instruct the user to install fleetd for their platform from internal shared drive folder [here](https://drive.google.com/drive/folders/1-hMwk4P7NRzCU5kDxkEcOo8Sluuaux1h?usp=drive_link). To enroll a windows or Ubuntu Linux device in dogfood, instruct the user to install fleetd for their platform from the [internal shared drive folder](https://drive.google.com/drive/folders/1-hMwk4P7NRzCU5kDxkEcOo8Sluuaux1h?usp=drive_link).
Once the user has installed fleetd, verify the device is correctly enrolled by confirming the device encryption key is in dogfood. Once the user has installed fleetd, verify the device is correctly enrolled by confirming the device encryption key is in dogfood.
@ -926,7 +926,7 @@ To add the most recent connections from Linkedin to our CRM, follow these steps:
Once a week, the Apprentice will review the "community activity report" and add the LinkedIn URLs into the campaign. This will send out a connection request to those who liked, shared, commented, etc. a post on LinkedIn. Once a week, the Apprentice will review the "community activity report" and add the LinkedIn URLs into the campaign. This will send out a connection request to those who liked, shared, commented, etc. a post on LinkedIn.
1. Export the [community activity report](https://fleetdm.lightning.force.com/lightning/r/Report/00OUG000002j3wf2AA/view). 1. Export the [community activity report](https://fleetdm.lightning.force.com/lightning/r/Report/00OUG000002j3wf2AA/view).
2. Copy the LinkedIn URLs. 2. Copy the LinkedIn URLs.
3. Paste the LinkedIn URLs [here](https://app.dripify.io/campaigns/1291030). 3. Paste the LinkedIn URLs in the [appropriate Dripify campaign](https://app.dripify.io/campaigns/1291030).
![image](https://github.com/user-attachments/assets/dc20c4c2-9691-4e70-bb9c-90b725403571) ![image](https://github.com/user-attachments/assets/dc20c4c2-9691-4e70-bb9c-90b725403571)

View file

@ -1784,7 +1784,7 @@ Fleet makes every effort to assure all third-party organizations are compliant a
### Anti-harassment policy ### Anti-harassment policy
> Fleet is committed to maintaing a harassment free workplace based on mutual respect and copmliance with the law. All Fleeties are required to comply with the anti-harassment policy set forth [here](https://docs.google.com/document/d/1qalY5_OcnCbHOJYUOz8R5O92RLortYrKdxur6Ned7ac/edit?usp=sharing). > Fleet is committed to maintaining a harassment free workplace based on mutual respect and compliance with the law. All Fleeties are required to comply with [Fleet's anti-harassment policy](https://docs.google.com/document/d/1qalY5_OcnCbHOJYUOz8R5O92RLortYrKdxur6Ned7ac/edit?usp=sharing).
### Investor policy ### Investor policy

View file

@ -127,16 +127,13 @@ To provide full-time focus to the role, the on-call engineer is not expected to
### Create a release candidate ### Create a release candidate
All minor releases go through the release candidate process before they are published. A release candidate for the next minor release is created on the last Friday of each sprint at 8:00 AM Pacific. A release candidate branch is created at `rc-minor-fleet-v4.x.x` and no additional feature work or released bug fixes are merged without EM and QA approval. All minor releases go through the release candidate process before they are published. A release candidate for the next minor release is created on the last Friday of each sprint at 8:00 AM Pacific (see [Fleet's release calendar](https://calendar.google.com/calendar/u/0?cid=Y192Nzk0M2RlcW4xdW5zNDg4YTY1djJkOTRic0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t)). A release candidate branch is created at `rc-minor-fleet-v4.x.x` and no additional feature work or released bug fixes are merged without EM and QA approval.
[Run the first step](https://github.com/fleetdm/fleet/tree/main/tools/release#minor-release-typically-end-of-sprint) of the minor release section of the Fleet releases script to create the release candidate branch, the release QA issue, and announce the release candidate in Slack. [Run the first step](https://github.com/fleetdm/fleet/tree/main/tools/release#minor-release-typically-end-of-sprint) of the minor release section of the Fleet releases script to create the release candidate branch, the release QA issue, and announce the release candidate in Slack.
During the release candidate period, the release candidate is deployed to our QA Wolf instance every morning instead of `main` to ensure that any new bugs reported by QA Wolf are in the upcoming release and need to be fixed before publishing the release. During the release candidate period, the release candidate is deployed to our QA Wolf instance every morning instead of `main` to ensure that any new bugs reported by QA Wolf are in the upcoming release and need to be fixed before publishing the release.
Open the [confidential repo environment variables](https://github.com/fleetdm/confidential/settings/variables/actions) page and update the `QAWOLF_DEPLOY_TAG` repository variable with the name of the release candidate branch. Open the [confidential repo environment variables](https://github.com/fleetdm/confidential/settings/variables/actions) page and update the `QAWOLF_DEPLOY_TAG` repository variable with the name of the release candidate branch.
You can see Fleet's release calendar [here](https://calendar.google.com/calendar/u/0?cid=Y192Nzk0M2RlcW4xdW5zNDg4YTY1djJkOTRic0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t).
### Merge unreleased bug fixes into the release candidate ### Merge unreleased bug fixes into the release candidate
@ -210,12 +207,11 @@ Once a product group completes its QA process during the release candidate perio
### Prepare Fleet release ### Prepare Fleet release
Documentation on completing the Fleet release process can be found [here](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/releasing-fleet.md). See the ["Releasing Fleet" contributor guide](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/releasing-fleet.md).
### Prepare fleetd agent release ### Prepare fleetd agent release
Documentation on completing the fleetd agent release process can be found [here](https://github.com/fleetdm/fleet/tree/main/tools/tuf/). See [Fleet's TUF release documentation](https://github.com/fleetdm/fleet/blob/main/tools/tuf/README.md).
### Deploy a new release to dogfood ### Deploy a new release to dogfood

View file

@ -39,10 +39,7 @@ As soon as we've addressed the next quarter's objectives, the Head of Product De
### Triage new bugs ### Triage new bugs
Product Designers are responsible for triaging all new reproduced bugs. Product Designers are responsible for [triaging all new reproduced bugs](https://fleetdm.com/handbook/company/product-groups#in-product-drafting).
Learn more [here](https://fleetdm.com/handbook/company/product-groups#in-product-drafting).
### Drafting ### Drafting

View file

@ -58,7 +58,7 @@ go build \
## Bugs ## Bugs
To report a bug or request a feature, [click here](https://github.com/fleetdm/fleet/issues). To report a bug or request a feature, [create an issue in the `fleet` GitHub repository](https://github.com/fleetdm/fleet/issues).
## Orbit Development ## Orbit Development

View file

@ -13690,7 +13690,7 @@
], ],
"evented": false, "evented": false,
"cacheable": false, "cacheable": false,
"notes": "- This table should be used sparingly as it uses an Apple API which occasionally corrupts the underlying certificate. Learn more [here](https://github.com/fleetdm/fleet/issues/13065#issuecomment-1658849614).", "notes": "- This table should be used sparingly as it uses an [Apple API which occasionally corrupts the underlying certificate](https://github.com/fleetdm/fleet/issues/13065#issuecomment-1658849614).",
"examples": "Identify Macs that contain certificates related to Apple application signing\nand notarization. (replace with your Apple Developer ID string)\n\n```\nSELECT * FROM keychain_items WHERE label LIKE '%8EHZ83LZNU%';\n```", "examples": "Identify Macs that contain certificates related to Apple application signing\nand notarization. (replace with your Apple Developer ID string)\n\n```\nSELECT * FROM keychain_items WHERE label LIKE '%8EHZ83LZNU%';\n```",
"columns": [ "columns": [
{ {

View file

@ -10,4 +10,4 @@ examples: |-
SELECT * FROM keychain_items WHERE label LIKE '%8EHZ83LZNU%'; SELECT * FROM keychain_items WHERE label LIKE '%8EHZ83LZNU%';
``` ```
notes: |- notes: |-
- This table should be used sparingly as it uses an Apple API which occasionally corrupts the underlying certificate. Learn more [here](https://github.com/fleetdm/fleet/issues/13065#issuecomment-1658849614). - This table should be used sparingly as it uses an [Apple API which occasionally corrupts the underlying certificate](https://github.com/fleetdm/fleet/issues/13065#issuecomment-1658849614).

View file

@ -31,7 +31,7 @@ brew install vexctl
#### A. "Affected" status #### A. "Affected" status
We will use [CVE-2025-27509](https://nvd.nist.gov/vuln/detail/CVE-2025-27509) as an example. We will use [CVE-2025-27509](https://nvd.nist.gov/vuln/detail/CVE-2025-27509) as an example.
This CVE affected all versions of Fleet at the time (more information [here](https://github.com/fleetdm/fleet/security/advisories/GHSA-52jx-g6m5-h735)). This CVE affected all versions of Fleet at the time (see the associated [GitHub security advisory](https://github.com/fleetdm/fleet/security/advisories/GHSA-52jx-g6m5-h735)).
##### 1. Creating "affected" status ##### 1. Creating "affected" status

View file

@ -1,6 +1,6 @@
# Moved # Moved
The Fleet Terraform Modules have moved to [here](https://github.com/fleetdm/fleet-terraform). The Fleet Terraform Modules have moved to [`fleetdm/fleet-terraform`](https://github.com/fleetdm/fleet-terraform).
The tags for all legacy versions of modules are still available by their named versions. The tags for all legacy versions of modules are still available by their named versions.

View file

@ -1,3 +1 @@
These scripts are for backing up and restore the Docker development MySQL database. These scripts are for backing up and restore the Docker development MySQL database, as described in the [testing and local developemt documentation](../../docs/Contributing/getting-started/testing-and-local-development.md#development-database-management).
Usage is documented [here](../../docs/Contributing/getting-started/testing-and-local-development.md#database-backuprestore).

View file

@ -129,7 +129,7 @@ It contains all the necessary information that a device needs to automatically e
[Example](https://fleetdm.com/example-dep-profile) [Example](https://fleetdm.com/example-dep-profile)
See all fields [here](https://developer.apple.com/documentation/devicemanagement/profile). See [Apple's Profile documentation](https://developer.apple.com/documentation/devicemanagement/profile) for all fields.
### Commands ### Commands

View file

@ -1,7 +1,7 @@
# Windows MDM Server Demo # Windows MDM Server Demo
This project is a working and minimal implementation of the Windows device enrollment and management protocols. It was based on an initial implementation of the MS-MDE enrollment protocols [here](https://github.com/oscartbeaumont/windows_mdm). This project is a working and minimal implementation of the Windows device enrollment and management protocols. It was based on an initial implementation of the MS-MDE enrollment protocols from [`oscartbeaumont/windows_mdm`](https://github.com/oscartbeaumont/windows_mdm).
This project uses the protocols: This project uses the protocols:
@ -14,11 +14,11 @@ This project uses the protocols:
The steps for MDE device enrollment correspond to five phases as shown in the following diagram: The steps for MDE device enrollment correspond to five phases as shown in the following diagram:
![enter image description here](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-mde/ms-mde_files/image002.png) ![Microsoft MDM enrollment workflow diagram](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-mde/ms-mde_files/image002.png)
## License ## License
This code is MIT licensed and it was forked from [here](https://github.com/oscartbeaumont/windows_mdm). Initial implementation credit goes to [Oscar Beaumont](https://github.com/oscartbeaumont). This code is MIT licensed and it was forked from [`oscartbeaumont/windows_mdm`](https://github.com/oscartbeaumont/windows_mdm). Initial implementation credit goes to [Oscar Beaumont](https://github.com/oscartbeaumont).
## Usage ## Usage

2
website/README.md vendored
View file

@ -4,7 +4,7 @@ This is where the code for the public https://fleetdm.com website lives.
## Bugs ## Bugs
To report a bug or make a suggestion for the website, [click here](https://github.com/fleetdm/fleet/issues). To report a bug or make a suggestion for the website, [create an issue in the `fleet` GitHub repository](https://github.com/fleetdm/fleet/issues).
## Testing locally ## Testing locally

View file

@ -195,7 +195,7 @@ module.exports = {
// `\n`+ // `\n`+
// `Please remember: never post in a public forum if you believe you've found a genuine security vulnerability. Instead, [disclose it responsibly](https://sailsjs.com/security).\n`+ // `Please remember: never post in a public forum if you believe you've found a genuine security vulnerability. Instead, [disclose it responsibly](https://sailsjs.com/security).\n`+
// `\n`+ // `\n`+
// `For help with questions about Sails, [click here](http://sailsjs.com/support).\n`; // `For help with questions about Sails, see the [Sails support page](http://sailsjs.com/support).\n`;
// } // }
// } // }
// // Now that we know what to say, add our comment. // // Now that we know what to say, add our comment.
@ -307,7 +307,7 @@ module.exports = {
// `\n`+ // `\n`+
// `Please remember: never post in a public forum if you believe you've found a genuine security vulnerability. Instead, [disclose it responsibly](https://sailsjs.com/security).\n`+ // `Please remember: never post in a public forum if you believe you've found a genuine security vulnerability. Instead, [disclose it responsibly](https://sailsjs.com/security).\n`+
// `\n`+ // `\n`+
// `For help with questions about Sails, [click here](http://sailsjs.com/support).\n`; // `For help with questions about Sails, see [Sails support](http://sailsjs.com/support).\n`;
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
if (action === 'edited' && pr.state !== 'open') {// PR edited ‡ if (action === 'edited' && pr.state !== 'open') {// PR edited ‡

View file

@ -6,7 +6,7 @@ A `landing-page` generator for use with the Sails command-line interface.
## Usage ## Usage
```bash ```bash
$ sails generate landing-page $ sails generate landing-page
``` ```
@ -17,9 +17,9 @@ See [Extending Sails > Generators > Custom Generators](https://sailsjs.com/docs/
<a href="https://sailsjs.com" target="_blank" title="Node.js framework for building realtime APIs."><img src="https://github-camo.global.ssl.fastly.net/9e49073459ed4e0e2687b80eaf515d87b0da4a6b/687474703a2f2f62616c64657264617368792e6769746875622e696f2f7361696c732f696d616765732f6c6f676f2e706e67" width=60 alt="Sails.js logo (small)"/></a> <a href="https://sailsjs.com" target="_blank" title="Node.js framework for building realtime APIs."><img src="https://github-camo.global.ssl.fastly.net/9e49073459ed4e0e2687b80eaf515d87b0da4a6b/687474703a2f2f62616c64657264617368792e6769746875622e696f2f7361696c732f696d616765732f6c6f676f2e706e67" width=60 alt="Sails.js logo (small)"/></a>
## Bugs ## Bugs
To report a bug, [click here](https://github.com/fleetdm/fleet/issues/new). To report a bug, [create an issue in the `fleet` GitHub repository](https://github.com/fleetdm/fleet/issues/new).
## Contributing ## Contributing