API docs always reflect the latest released version

[noahtalerman]

Today, the API docs can reflect an unreleased version of the API (main branch).

This happens because changes made to the docs, that are merged into the main branch, are automatically deployed to fleetdm.com.

Goal

As a user, I want the API docs to always reflect the latest released version of Fleet so that I know the integration I'm building will work with my Fleet instance.

How?

Proposed solution:

• At the start of each release cycle, a member of the Developer relations (DevRel) team creates a new branch (ex. api-docs-4.16.0)
• On each pull request (PR) that includes changes to the API, a member of the DevRel team grabs the API doc changes, updates them (if needed), submits a separate PR to the api-docs-4.16.0 branch, and updates the Postman Collection.
• The engineer working on the PR that includes changes to the API reverts the docs changes before merging into main.