microsoft / microsoft/AzureTRE
Documentation Improvements
Open
Nobody has claimed this yet.
documentation
feature
- Dominant language
- Python
- Stars
- 235
- Forks
- 192
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 13
Description
There are a number of issues with the current AzureTRE docs. We'd like to...
- add new documents
- enhance existing documentation
... but the structure of the existing docs does not lend itself to being extended.
This feature tracks a number of User Stories to...
- #2215
- #2438
- #2381
- #2337
- #2296
- #2216
- #1259
- #1751
- #2217
- #2586
- #2612
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
Review the remaining unchecked user stories #2216, #1751, and #2217 alongside the current AzureTRE documentation structure. No files or tests are named, so first locate the documentation entry points and use the listed stories to define the scope; done means the remaining documentation improvements and structural changes are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100