diff --git a/.github/ISSUE_TEMPLATE/story.md b/.github/ISSUE_TEMPLATE/story.md index ff3a74d0bc..7f6bae0589 100644 --- a/.github/ISSUE_TEMPLATE/story.md +++ b/.github/ISSUE_TEMPLATE/story.md @@ -25,7 +25,7 @@ It is [planned and ready](https://fleetdm.com/handbook/company/development-group - [ ] UI changes: TODO - [ ] CLI (fleetctl) usage changes: TODO - [ ] YAML changes: TODO -- [ ] REST API changes: TODO +- [ ] REST API changes: TODO - [ ] Fleet's agent (fleetd) changes: TODO - [ ] Fleet server configuration changes: TODO - [ ] Exposed, public API endpoint changes: TODO diff --git a/handbook/product-design/README.md b/handbook/product-design/README.md index b12b0e28bf..accc7e8b96 100644 --- a/handbook/product-design/README.md +++ b/handbook/product-design/README.md @@ -59,10 +59,11 @@ At Fleet, like [GitLab](https://about.gitlab.com/handbook/product-development-fl 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`. + - If an API endpoint is being added, document it in [`api_endpoints.yml`](https://github.com/fleetdm/fleet/blob/main/server/api_endpoints/api_endpoints.yml). (This allows granular access for API-only users.) - 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). + - After your changes are approved by the API design DRI, they will merge your changes into the docs release branch. 4. Add links to the user story as specified in the [issue template](https://github.com/fleetdm/fleet/issues/new?template=story.md).