microsoft / microsoft/api-guidelines
Clarify guidelines on Bring-Your-Own-Storage
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
Some teams report that the current language is confusing, e.g. "Is "Bring Your Own Storage" a design pattern or service/API/library?"
We should try to clarify that it is the customer that creates and stores the data into an Azure Storage account and then just provides the location of the data to the API.
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
Read the current Bring-Your-Own-Storage guidance in the API Guidelines and identify the wording that causes confusion about whether it is a design pattern, service, or API/library. Clarify that the customer creates and stores the data in an Azure Storage account and provides the data location to the API; done when that responsibility is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100