Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

Update README.md for product design guidelines (#47879)

Browse Source 
Removing step 3 - not doing this
This commit is contained in:
LeAnn
2026-06-18 18:31:29 -04:00
committed by GitHub
parent 567c02c4f8
commit c7678dc0a6
1 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
handbook/product-design/README.md
+4 -6
View File
@@ -53,20 +53,18 @@ At Fleet, like [GitLab](https://about.gitlab.com/handbook/product-development-fl
- **Ready**: Use this page to communicate design reviews and development.
- **Scratchpad**: Use this page to keep "work in progress" designs that might be useful in the future.
3. Add page names (e.g. "Host details" page) to the user story's title and/or description to help contributors find Figma wireframes for the area of the UI you're making changes to.
4. If the story requires API or YAML file changes, open a pull request (PR) to the reference docs with the proposed design. Pay attention to existing conventions (URL structure, parameter names, response format) and aim to be consistent. Your PR should follow these guidelines:
3. If the story requires API or YAML file changes, open a pull request (PR) to the reference docs with the proposed design. Pay attention to existing conventions (URL structure, parameter names, response format) and aim to be consistent. Your PR should follow these guidelines:
- Make a PR against the docs release branch for the version you expect this feature to be in. Docs release branches are named using the format `docs-vX.X.X`, so if you're designing for Fleet 4.61.0, you would make a PR to `docs-v4.61.0`.
- Add a link to the issue in the PR description.
- Attach the `~api-or-yaml-design` label. (This helps the [API design DRI](https://fleetdm.com/handbook/company/communications#directly-responsible-individuals-dris) prioritize API/YAML PR review.)
- Mark the PR ready for review. (Draft PRs do not auto-request reviews.)
- After your changes are approved by the API design DRI, they will merge your changes into the docs release branch. Changes to the activity feed (audit logs) are closed instead of merged because the [audit-logs.md file is auto-generated](https://fleetdm.com/handbook/company/communications#audit-logs).
5. Add links to the user story as specified in the [issue template](https://github.com/fleetdm/fleet/issues/new?template=story.md).
4. Add links to the user story as specified in the [issue template](https://github.com/fleetdm/fleet/issues/new?template=story.md).
6. If you (Product Designer) have capacity to update Fleet's guides, add a link to the guide update PR in the "Feature guide changes" checkbox under the "Engineering" section. If not, it's up to the Engineer assigned to the story during implementation to make sure guides are updated.
5. If you (Product Designer) have capacity to update Fleet's guides, add a link to the guide update PR in the "Feature guide changes" checkbox under the "Engineering" section. If not, it's up to the Engineer assigned to the story during implementation to make sure guides are updated.
7. Draft changes to the Fleet product that solve the problem specified in the story.
6. Draft changes to the Fleet product that solve the problem specified in the story.
- Constantly place yourself in the shoes of a user while drafting changes.
- Use dev notes (component available in our library) to highlight important information to engineers and other teammates. - Reach out to sales, customer success, and demand for a business perspective.
- Engage engineering to gain insight into technical costs and feasibility.