docs: add docs for RTD #631
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
alesstimec
approved these changes
Nov 18, 2024
|
/merge |
|
@tmihoc some of the new GitHub Actions are failing due to:
the markdown-lint action doesn't like the current from https://github.com/juju/terraform-provider-juju/actions/runs/11911988799/job/33194654028?pr=631 |
anvial
approved these changes
Nov 28, 2024
Aflynn50
reviewed
Nov 28, 2024
| name: Main Documentation Checks | ||
|
|
||
| on: | ||
| push: |
There was a problem hiding this comment.
This should be made period, or disabled, similar to the one on main. See: juju/juju#18427
| @@ -0,0 +1,19 @@ | |||
| name: Periodic Style Checks | |||
There was a problem hiding this comment.
It would be worth running this manually to check it works.
alesstimec
reviewed
Dec 2, 2024
alesstimec
reviewed
Dec 2, 2024
tmihoc
force-pushed
the
rtd-docs
branch
2 times, most recently
from
d941f33 to
557d781
Compare
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 creates a docs/docs-rtd directory with a Sphinx project and docs content from Discourse for a newly created RTD project.
The content for now mainly consists of a homepage, tutorial, and how-to guides.
The links to
juju(i.e., juju/juju repo) concepts are for now pointing to juju,is. That should work, because any pages moved out of there will have redirects, so the links should be fine. The links toterraform-provider-jujureference are for now to the Terraform Registry home of the provider.TODO: In a follow-up PR it would be good to use the docs/docs-rtd/reference directory to hold all tool reference materials. These are currently under docs/data-sources and docs/resources. When we move them to reference we should consider how that will affect the content on https://registry.terraform.io/providers/juju/juju/latest/docs . In principle, the Terraform Registry page should contain nothing more than autogenerated reference plus a link to the new terraform-provider-juju RTD project, which will contain the complete set of terraform-provider-juju docs, user docs as well as developer docs.
Fixes:
Type of change
Documentation.
Environment
Juju controller version:
Terraform version:
QA steps
Additional notes
JIRA card: JUJU-7097