Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need separate staging branches to avoid releasing incomplete docs #80

Open
Chris-Petty opened this issue Sep 5, 2024 · 1 comment
Open

Comments

@Chris-Petty
Copy link
Contributor

Currently https://docs-staging.msupply.foundation/ has content from develop branch of this repo. This is useful for reviewing docs internally and for testers before we release products. https://docs.msupply.foundation/ is from the main branch.

An issue arises when a product is released and it's docs need to go live so we merge develop into main. This also takes any drafted docs of other products in develop/staging to the live/production docs, releasing the docs ahead of actual product release.

This occurred a couple weeks ago when OMS released along with new docs, and HSH docs in staging got released too but the release is still in testing/fixing. This has lead PMs (and potentially users) to see features in docs and then be unable to find them in in production, with support requests to boot.

Solutions

  • Different staging branch for each product. Different URL for each product-staging-docs.msupply.org??
  • Different branch for each product. Merge into staging for testers/demo. Fixes and tweaks go into product branch and merged into staging until ready. When ready, merge the product branch into main.
  • other?
@jmbrunskill
Copy link
Contributor

How about separate repos & sites for different products? E.g. docs.health-supply-hub.org or maybe more likely docs.health-supply-hub.msupply.org

Not sure if we can do re-direction from github pages though to make sure existing links still work?

Could still have different repos for different products and combine them when deploying potentially?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants