radius-project / radius-project/docs
Add "Branch Guidance" docs page for docs and samples repos
Nobody has claimed this yet.
- Dominant language
- Bicep
- Stars
- 26
- Forks
- 52
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 3
Description
What content needs to be created or modified?
The Git branch strategy for docs is different than most projects (i.e., we use release branches as the main branches and edge as prerelease. We should provide a "Branch Guidance" docs page to clear up any confusion about this.
Describe the solution you'd like
A page similar to https://docs.dapr.io/contributing/docs-contrib/contributing-docs/#branch-guidance which outlines how we handle branching for docs and samples.
Contributor guide
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.
Research direction
Start by reviewing the linked Dapr branch-guidance page and the existing documentation structure for docs and samples. Create a comparable "Branch Guidance" page explaining that release branches are the main branches and edge is prerelease; the work is done when the guidance is available for contributors to both repositories.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100