-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add docs for terraform provider juju rtd
- Loading branch information
Showing
55 changed files
with
3,326 additions
and
1 deletion.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
name: Main Documentation Checks | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
paths: | ||
- 'docs-rtd/**' | ||
pull_request: | ||
paths: | ||
- 'docs-rtd/**' | ||
workflow_dispatch: | ||
paths: | ||
- 'docs-rtd/**' | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
documentation-checks: | ||
uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main | ||
with: | ||
working-directory: "docs-rtd" |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
name: Periodic Style Checks | ||
|
||
on: | ||
schedule: | ||
- cron: "0 1 * * 4" # Runs at 01:00 AM on every Wednesday | ||
|
||
jobs: | ||
vale: | ||
name: Style checker | ||
runs-on: ubuntu-22.04 | ||
defaults: | ||
run: | ||
shell: bash | ||
working-directory: "docs-rtd" | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Run vale | ||
run: | | ||
make vale |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the version of Python and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.11" | ||
jobs: | ||
pre_install: | ||
- git fetch --unshallow || true | ||
|
||
# Build documentation in the docs/ directory with Sphinx | ||
sphinx: | ||
builder: dirhtml | ||
configuration: docs-rtd/conf.py | ||
fail_on_warning: true | ||
|
||
# If using Sphinx, optionally build your docs in additional formats such as PDF | ||
formats: | ||
|
||
# Optionally declare the Python requirements required to build your docs | ||
python: | ||
install: | ||
- requirements: docs-rtd/.sphinx/requirements.txt |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
docs-rtd/.wokeignore |
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
CIDRs | ||
CPUs | ||
Hashicorp | ||
MicroK | ||
Multipass | ||
SREs | ||
TLS | ||
Terraform | ||
Unexpose | ||
declaratively | ||
juju | ||
localhost | ||
macOS | ||
natively | ||
terraform | ||
unexpose |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
|
||
# Starter pack rules start here | ||
/*env*/ | ||
.sphinx/venv/ | ||
.sphinx/warnings.txt | ||
.sphinx/.wordlist.dic | ||
.sphinx/.doctrees/ | ||
.sphinx/node_modules/ | ||
package*.json | ||
_build | ||
.DS_Store | ||
__pycache__ | ||
.idea/ | ||
.vscode/ | ||
.sphinx/styles/* | ||
.sphinx/vale.ini | ||
sp-docs/_build |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"default": false, | ||
"MD003": { | ||
"style": "atx" | ||
}, | ||
"MD013": false, | ||
"MD014": true, | ||
"MD018": true, | ||
"MD022": true, | ||
"MD023": true, | ||
"MD026": { | ||
"punctuation": ".,;。,;" | ||
}, | ||
"MD031": { | ||
"list_items": false | ||
}, | ||
"MD032": true, | ||
"MD035": true, | ||
"MD042": true, | ||
"MD045": true, | ||
"MD052": true | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
ACME | ||
ACME's | ||
addons | ||
AGPLv | ||
API | ||
APIs | ||
balancer | ||
Charmhub | ||
CLI | ||
DCO | ||
Diátaxis | ||
Dqlite | ||
dropdown | ||
EBS | ||
EKS | ||
enablement | ||
favicon | ||
Furo | ||
Git | ||
GitHub | ||
Grafana | ||
IAM | ||
installable | ||
JSON | ||
Juju | ||
Kubeflow | ||
Kubernetes | ||
Launchpad | ||
linter | ||
LTS | ||
LXD | ||
Makefile | ||
Makefiles | ||
Matrix | ||
Mattermost | ||
MicroCeph | ||
MicroCloud | ||
MicroOVN | ||
MyST | ||
namespace | ||
namespaces | ||
NodePort | ||
Numbat | ||
observability | ||
OEM | ||
OLM | ||
Permalink | ||
pre | ||
Quickstart | ||
ReadMe | ||
reST | ||
reStructuredText | ||
roadmap | ||
RTD | ||
subdirectories | ||
subfolders | ||
subtree | ||
TODO | ||
Ubuntu | ||
UI | ||
UUID | ||
VM | ||
webhook | ||
YAML |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
/* Only relevant for specific PDF generation issues */ | ||
|
||
.rubric>.hclass2 { | ||
display: block; | ||
font-size: 2em; | ||
border-radius: .5rem; | ||
font-weight: 300; | ||
line-height: 1.25; | ||
margin-top: 1.75rem; | ||
margin-right: -0.5rem; | ||
margin-bottom: 0.5rem; | ||
margin-left: -0.5rem; | ||
padding-left: .5rem; | ||
padding-right: .5rem; | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<header id="header" class="p-navigation"> | ||
|
||
<div class="p-navigation__nav" role="menubar"> | ||
|
||
<ul class="p-navigation__links" role="menu"> | ||
|
||
<li> | ||
<a class="p-logo" href="https://{{ product_page }}" aria-current="page"> | ||
<img src="{{ pathto(product_tag,1) }}" alt="Logo" class="p-logo-image"> | ||
<div class="p-logo-text p-heading--4">{{ project }} | ||
</div> | ||
</a> | ||
</li> | ||
|
||
<li class="nav-ubuntu-com"> | ||
<a href="https://{{ product_page }}" class="p-navigation__link">{{ product_page }}</a> | ||
</li> | ||
|
||
<li> | ||
<a href="#" class="p-navigation__link nav-more-links">More resources</a> | ||
<ul class="more-links-dropdown"> | ||
|
||
{% if discourse %} | ||
<li> | ||
<a href="{{ discourse }}" class="p-navigation__sub-link p-dropdown__link">Discourse</a> | ||
</li> | ||
{% endif %} | ||
|
||
{% if mattermost %} | ||
<li> | ||
<a href="{{ mattermost }}" class="p-navigation__sub-link p-dropdown__link">Mattermost</a> | ||
</li> | ||
{% endif %} | ||
|
||
{% if matrix %} | ||
<li> | ||
<a href="{{ matrix }}" class="p-navigation__sub-link p-dropdown__link">Matrix</a> | ||
</li> | ||
{% endif %} | ||
|
||
{% if github_url %} | ||
<li> | ||
<a href="{{ github_url }}" class="p-navigation__sub-link p-dropdown__link">GitHub</a> | ||
</li> | ||
{% endif %} | ||
|
||
</ul> | ||
</li> | ||
|
||
</ul> | ||
</div> | ||
</header> |
Oops, something went wrong.