docs: Standardise integration articles #6771
Description
Most — likely all — Flagsmith integrations included in our documentation will need the same structure:
- What to expect
- How it works
- Pre-requisites
- How to setup
The content in each of the above sections will vary according to each integration, but the structure should be very similar.
We're expected to see increased quality in content and contribution, and decreased time in reviewing documentation, if we adopt patterns to guide integration docs.
For example, rather than having discussions like this, we could standardise on a way to cite pre-requisites to configure an integration:
Pre-requisites
- An Organisation API key: obtain from Organisation settings > API keys in Flagsmith.
- The Project ID: obtain from the Flagsmith dashboard URL, e.g.
/project/<id>/....[!NOTE]
Enterprise users: when generating the Organisation API key, select permissions {permissions}, so that {integration} can {action}.
Acceptance criteria
- Write a template for third-party integrations that include the standard sections and default content. Writers can start from a booster right into writing text and adding screenshots.
- Include placeholder for screenshots in the template throughout the sections where applicable. These must be the minimum accepted screenshots in an article. Adding more screenshots is recommended.