SovereignCloudStack / SovereignCloudStack/docs
Need cross-repo CI tests for docs pages
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- JavaScript
- Stars
- 18
- Forks
- 10
- Avg merge
- 15h 16m
- Merged PRs (30d)
- 2
Description
The docs pages pull in content from lots of other repositories.
This is good, as it leaves the documentation where the code is, vastly increasing the chances that docs are in sync with code changes, supporting a decentralized engineering model.
However, it comes with the downside that changes in one repo can easily break the docs pages build, making the whole build process fragile. Classic CI does not handle this well, as the PRs that break the docs are not triggering docs CI builds.
We should think about a design that avoids this fragility.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.