documentation updates #397
Conversation
templates/index.md.tmpl
Outdated
|
|
||
| * `$XDG_DATA_HOME/juju` | ||
| * `~/.local/share/juju` | ||
| ### Populated by provider via the juju cli client. |
There was a problem hiding this comment.
It might be worth to also add here that the provider is not dependent on the juju-cli (mostly to avoid future queries about that).
There was a problem hiding this comment.
See my comments for the other file.
hmlanigan
force-pushed
the
update-index.md
branch
from
25e3a80 to
ea57ba4
Compare
docs/index.md
Outdated
| @@ -10,11 +10,24 @@ description: |- | |||
|
|
|||
| The provider can be used to interact with [Juju][0] - a model-driven Operator Lifecycle Manager (OLM) by Canonical. | |||
There was a problem hiding this comment.
According to the current Juju terminology guidelines, we should drop the "OLM" verbiage.
There was a problem hiding this comment.
What's the replacement? Going with an open source orchestration engine by Canonical. from juju.is for now.
templates/index.md.tmpl
Outdated
|
|
||
| * `$XDG_DATA_HOME/juju` | ||
| * `~/.local/share/juju` | ||
| ### Populated by provider via the juju cli client. |
There was a problem hiding this comment.
See my comments for the other file.
templates/index.md.tmpl
Outdated
|
|
||
| The intention is to remove this dependency in future. | ||
| This is the most straight-forward solution. Remember, that it will use the configuration used by the CLI at that moment. The fields are populated using the output from running the command: |
There was a problem hiding this comment.
See my comments for this portion in the other file above.
There was a problem hiding this comment.
Suggested some typo fixes. Will leave it up to you whether to fix them now or later. They generally boil down to:
- Use normal language, including all the articles, even in the titles (E..g, "Populated by the provider via the Juju CLI client").
- Spell "
juju" when you mean thejujuCLI and "Juju" otherwise. - Spell "CLI" with caps.
Other than that, looks good, thanks!
hmlanigan
force-pushed
the
update-index.md
branch
from
b88c913 to
3cc9437
Compare
|
Made the last set of changes and squashed the commits. Thank you @tmihoc for the detailed review. |
Update authentication methods and the list of supported resources and data sources.
The template is combined with the files in examples/provider/ to create: https://registry.terraform.io/providers/juju/juju/latest/docs
JUJU-5405