Skip to content

docs: Adds Release Pipelines documentation#5712

Merged
tiagoapolo merged 14 commits intomainfrom
feat/release-pipeline-documentation
Jul 11, 2025
Merged

docs: Adds Release Pipelines documentation#5712
tiagoapolo merged 14 commits intomainfrom
feat/release-pipeline-documentation

Conversation

@tiagoapolo
Copy link
Contributor

@tiagoapolo tiagoapolo commented Jul 5, 2025

Thanks for submitting a PR! Please check the boxes below:

  • I have added information to docs/ if required so people know about the feature!
  • I have filled in the "Changes" section below?
  • I have filled in the "How did you test this code" section below?
  • I have used a Conventional Commit title for this Pull Request

Changes

Adds docs #5699

How did you test this code?

Please describe.

@tiagoapolo tiagoapolo requested review from a team as code owners July 5, 2025 00:13
@tiagoapolo tiagoapolo requested review from Zaimwa9 and removed request for a team July 5, 2025 00:13
@vercel
Copy link

vercel bot commented Jul 5, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 11, 2025 9:29pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
flagsmith-frontend-preview ⬜️ Ignored (Inspect) Visit Preview Jul 11, 2025 9:29pm
flagsmith-frontend-staging ⬜️ Ignored (Inspect) Visit Preview Jul 11, 2025 9:29pm

@tiagoapolo tiagoapolo marked this pull request as draft July 5, 2025 00:13
@github-actions github-actions bot added front-end Issue related to the React Front End Dashboard docs Documentation updates feature New feature or request and removed docs Documentation updates labels Jul 5, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Jul 5, 2025

Docker builds report

Image Build Status Security report
ghcr.io/flagsmith/flagsmith-api-test:pr-5712 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-e2e:pr-5712 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-api:pr-5712 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-frontend:pr-5712 Finished ✅ Results
ghcr.io/flagsmith/flagsmith:pr-5712 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-private-cloud:pr-5712 Finished ✅ Results

@github-actions github-actions bot added the docs Documentation updates label Jul 7, 2025
@github-actions github-actions bot added feature New feature or request and removed feature New feature or request docs Documentation updates labels Jul 7, 2025
@tiagoapolo tiagoapolo marked this pull request as ready for review July 7, 2025 22:39
@tiagoapolo tiagoapolo self-assigned this Jul 7, 2025
@github-actions github-actions bot added feature New feature or request and removed feature New feature or request labels Jul 7, 2025
@matthewelwell matthewelwell changed the title feat: Adds Release Pipelines documentation docs: Adds Release Pipelines documentation Jul 8, 2025
@github-actions github-actions bot added docs Documentation updates and removed feature New feature or request labels Jul 8, 2025
Copy link
Contributor

@emyller emyller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From a technical perspective, the documentation looks excellent: it tells how to operate. However, I fail to understand the value of the product after reading.

Questions I don't see clear answers for:

  1. What kind of role is this product suited for? i.e. who is this documentation for in the use case definition?
  2. In my product release management, how is automating feature flag changes useful? Why would I go and switch from my usual/comfortable routine of managing and observing releases and user feedback?
  3. Does it allow me to gradually increase my audience for a new feature?
  4. What happens if an automated feature flag change unintentionally degrades user experience in my product?

From a general user perspective, this page looks like one of those features I will probably never need. So maybe if we enhance it with real-world examples, including screenshots/diagrams that help sell the product, we could make it easier for people to understand the value of this and adhere faster.

Copy link
Contributor

@matthewelwell matthewelwell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the whole, this looks good, but I agree with @emyller 's suggestion that the docs are lacking examples currently. Let's add in at least one (preferably more than one) of the examples from the Figma prototype here.

@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Jul 11, 2025
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Jul 11, 2025
@tiagoapolo tiagoapolo requested a review from emyller July 11, 2025 13:29
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Jul 11, 2025
Copy link
Contributor

@emyller emyller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Text and examples are much better, thank you!
Minor comments to resolve.

For later: once the UX stabilizes, let's coordinate refreshing screenshots.


![Use Case](/img/release-pipelines/use-case-pipeline.png)

Release Pipelines act as your intelligent release assistant, automating your entire feature flag deployment process. Define stages that your flags progress through automatically, with triggers and actions that control rollouts to selected environments and audiences. Release Pipelines can automatically generate change requests when promoting flags to production, eliminating manual effort and streamlining your deployment workflow.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Jul 11, 2025
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Jul 11, 2025
Copy link
Contributor

@emyller emyller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tiagoapolo tiagoapolo dismissed Zaimwa9’s stale review July 11, 2025 22:36

already approved by another dev

@tiagoapolo tiagoapolo merged commit b76332c into main Jul 11, 2025
26 checks passed
@tiagoapolo tiagoapolo deleted the feat/release-pipeline-documentation branch July 11, 2025 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation updates front-end Issue related to the React Front End Dashboard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants