feat: add jaas resource docs #594
Merged
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
kian99
force-pushed
the
jaas-resource-docs
branch
4 times, most recently
from
6aaed14
to
5f7b9c0
Compare
hmlanigan
reviewed
Sep 25, 2024
| @@ -8,7 +8,8 @@ description: |- | |||
|
|
|||
| # Juju Provider | |||
|
|
|||
| The provider can be used to interact with [Juju][0] - an open source orchestration engine by Canonical. | |||
| The provider can be used to interact with [Juju][0] - an open source orchestration engine by Canonical. | |||
| Additionally, the provider supports interactions with [JAAS][1] - an orchestrator of Juju controllers. | |||
There was a problem hiding this comment.
Perhaps this is a good time to update the description in this section: https://github.com/juju/terraform-provider-juju/blob/5f7b9c08783490a6d2cd7b231248ee869cdc1c27/docs/index.md#client-credentials
To include they are used to connect to JAAS? It's not clear in the Authentication section which values will work for JAAS.
There was a problem hiding this comment.
I've added a note in that section, let me know if I should expand it.
- Simplify imports by eliminating the need for users to provide the resource type - Add note that client credentials auth is only supported with JAAS
kian99
force-pushed
the
jaas-resource-docs
branch
from
5f7b9c0
to
4d25221
Compare
hmlanigan
approved these changes
Sep 26, 2024
|
/merge |
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.
Description
This PR adds documentation for all JAAS resources. Additionally it simplifies imports so that users don't have to specify the resource type in the import.
Full changes include:
make docsto generate new docs.Fixes: CSS-10812
Type of change