microsoft / microsoft/api-guidelines
API Guidance does not explain the term `workload`
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
API Guidance does not explain the term workload. Although, it refers to that term several times - https://github.com/search?q=repo%3Amicrosoft%2Fapi-guidelines%20workload&type=code
There is a need to explain the context of this term using backing service, domain, implementation, deployable runtime, etc.
Given the repo is public, I'm assuming the target audience of this literature is anyone on internet.
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
Search the repository for the existing uses of workload, starting with the linked GitHub code search. Identify the guidance page where the term is introduced and add an explanation covering backing service, domain, implementation, and deployable runtime. Done means readers can understand the term in its API guidance context.
Written by the indexing model from the issue text.
Assessment
- Domain
- backend-api-design, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100