Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Documentation Refactoring #1728

Closed
wants to merge 3 commits into from
Closed

Conversation

tombuildsstuff
Copy link
Contributor

This PR is still a WIP, but this refactors the Documentation and Examples quite significantly.

The primary purpose of this PR is to make the examples clearer to read, since the "Example Usage" section is intended to be how to use the singular resource, rather than a complete example (and we should be pointing to the examples directory in the repository for other samples).

Resources with multiple examples have been moved into the examples/ folder with a cross-link between the docs page and the repo examples folder. This PR also starts the task of grouping examples by type (e.g. App Service, VM's etc) - which is of a larger-scope than this PR, but should provide a foundation.

There's still a bunch of work needed for this:

  • Finish working through the outstanding resources
  • Re-splitting this into multiple commits to make it reviewable
  • Testing each of the Examples

@metacpp
Copy link
Contributor

metacpp commented Aug 15, 2018

@tombuildsstuff you need to split this PR into smaller, iterative PRs to avoid conflicts with other contributors working on the same MD files.

@tombuildsstuff
Copy link
Contributor Author

@metacpp given this is a cross-cutting PR this makes sense to do as a single PR rather than incrementally - as such splitting this out will only cause more overhead - we'll rebase this when we come back to it (once #1746 has been merged)

@tombuildsstuff
Copy link
Contributor Author

Closing this for the moment

@tombuildsstuff tombuildsstuff deleted the docs-exampleusage branch December 14, 2018 10:07
@ghost
Copy link

ghost commented Mar 5, 2019

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. If you feel I made an error 🤖 🙉 , please reach out to my human friends 👉 [email protected]. Thanks!

@ghost ghost locked and limited conversation to collaborators Mar 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants