Azure-Samples / Azure-Samples/azure-sdk-for-go-samples

add README.md files to directories

Open Beginner friendly
#98 0 comments 0 reactions 0 assignees View on GitHub
backlog docs P1
Dominant language
Go
Stars
308
Forks
186
PR merge metrics
No merged PRs in 30d

Description

Thank you for your contribution and feedback! Help us review faster by providing the following information:

## This issue is a: (mark with an `x`)

- [ ] bug report
- [ ] request for new sample
- [X] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

## Further info:

The official Microsoft site documentation for Azure SDK for Go (docs.microsoft.com/go/azure) links to the following sample directories without a `README.md`:

* https://github.com/Azure-Samples/azure-sdk-for-go-samples/tree/master/compute
* https://github.com/Azure-Samples/azure-sdk-for-go-samples/tree/master/containerinstance
* https://github.com/Azure-Samples/azure-sdk-for-go-samples/tree/master/containerservice

There should be at least a short README in these directories so that users have more context after following links from the documentation site to the samples.

Contributor guide

Open the contributing guide

Research direction

Review the compute, containerinstance, and containerservice sample directories in the repository, then compare their contents with the links from the Azure SDK for Go documentation. Add a short README.md to each directory that gives users context for the samples. Done means all three linked directories contain a README.md.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.