Feature/webdocs #46
Merged
Feature/webdocs #46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Not sure why the tests are failing, this PR only changes the markdown docs, any insight from the maintainers? |
|
Looks like the tests failed because the plugin sdk was outdated @fbreckle can you kick off the tests again? |
added 2 commits
April 26, 2021 09:36
|
Quick note... as each doc includes a sample usage, this would also address #39. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is similar to the existing draft PR #21 , however I have gone ahead and filled in each resource/data source with details and references to the official documentation.
This PR also adds a guide section that offers a sample use case that will be visible in the register (similar to the Unifi provider).
While I agree that incorporating the gen into a git hook would be ideal, manually generating the docs for now will help with the registry visibility/usability.