Merge pull request #1 from rkratky/pr-631

Docs checks fixes

.github/workflows/automatic-doc-checks.yml

@@ -3,9 +3,14 @@ name: Main Documentation Checks
 on:
   push:
     branches: [main]
+    paths:
+      - 'docs-rtd/**'
   pull_request:
-  # Manual trigger
+    paths:
+      - 'docs-rtd/**'
   workflow_dispatch:
+    paths:
+      - 'docs-rtd/**'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -15,4 +20,4 @@ jobs:
   documentation-checks:
     uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
     with:
-      working-directory: "."
+      working-directory: "docs-rtd"

.github/workflows/markdown-style-checks.yml

@@ -2,20 +2,25 @@ name: "Linter for Markdown"
 
 on:
   push:
-    branches:
-      - main
+    branches: [main]
+    paths:
+      - 'docs-rtd/**'
   pull_request:
-    branches:
-      - '*'
+    paths:
+      - 'docs-rtd/**'
+  workflow_dispatch:
+    paths:
+      - 'docs-rtd/**'
 
 jobs:
   markdown-lint:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0     
+          fetch-depth: 0
       - uses: DavidAnson/markdownlint-cli2-action@v16
         with:
           config: "docs-rtd/.sphinx/.markdownlint.json"
-
+          globs: "docs-rtd/**/*.md"
+          continue-on-error: true

.github/workflows/periodic-style-checks.yml

@@ -11,7 +11,7 @@ jobs:
     defaults:
       run:
         shell: bash
-        working-directory: "sp-docs"
+        working-directory: "docs-rtd"
     steps:
       - uses: actions/checkout@v4
       - name: Run vale

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 0.15.0 (October 14, 2024)
 
 NOTES:
+
 * **This release requires Juju controller version 2.9.49 or higher juju.**
 * **If using JAAS, this release requires Juju controller version 3.5.0 or higher.**
 * This release uses juju client api code from the juju 3.5.1 release.
@@ -26,6 +27,7 @@ BUG FIXES:
 ## 0.14.0 (September 9, 2024)
 
 NOTES:
+
 * **This release requires juju controller version 2.9.49 or later juju.**
 * This release uses juju client api code from the juju 3.5.1 release.
 
@@ -44,6 +46,7 @@ BUG FIXES:
 ## 0.13.0 (July 15, 2024)
 
 NOTES:
+
 * **This release requires juju controller version 2.9.49 or later juju.**
 * This release uses juju client api code from the juju 3.5.1 release.
 
@@ -62,12 +65,14 @@ BUG FIXES:
 ## 0.12.0 (April 22, 2024)
 
 NOTES:
+
 * **This release requires juju controller version 2.9.49 or later juju.**
 * This release uses juju client api code from the juju 3.5-beta1 candidate release.
 * The added JAAS login enhancements requires Juju controller version 3.5.0 or higher.
 * The added Juju secrets support requires Juju controller version 3.4.0 or higher.
 
 ENHANCEMENTS:
+
 * Support for user secret management is added. You can now use `juju_secret` and `juju_access_secret` resources to create and manage secrets, as well as grant/revoke access to the applications in your plan. You can also use `juju_secret` data source in your configuration to access a secret.
 * Provider config is enhanced with support for Client ID and secret to enable logging in to JAAS using client credentials.
 
@@ -79,6 +84,7 @@ BUG FIXES:
 ## 0.11.0 (March 18, 2024)
 
 NOTES:
+
 * **This release requires juju controller version 2.9.47 or later juju.**
 * This release uses juju client api code from the juju 3.3.0 release. 
 
@@ -93,6 +99,7 @@ ENHANCEMENTS:
 applications. This is similar to `juju deploy --bind` and `juju bind` commands.
 
 BUG FIXES:
+
 * Fix upgrade charm revision for application resources by @hmlanigan in https://github.com/juju/terraform-provider-juju/pull/414
 * Fixes Config/Revision update ordering. by @anvial in https://github.com/juju/terraform-provider-juju/pull/407
 * Adds error check to ReadModel function by @anvial in https://github.com/juju/terraform-provider-juju/pull/416

README.md

@@ -74,12 +74,14 @@ export TF_LOG_PROVIDER=TRACE ; export TF_LOG_PATH=./terraform.log
 Run your terraform commands.
 
 To find logs specific to the juju provider code:
+
 ```shell
 grep "@module=juju.resource" ./terraform.log
 grep "@module=juju.datasource" ./terraform.log
 ```
 
 To find logs specific to the juju client talking to juju itself:
+
 ```shell
 grep "@module=juju.client" ./terraform.log
-```
+```

docs-rtd/.custom_wordlist.txt

@@ -0,0 +1,16 @@
+CIDRs
+CPUs
+Hashicorp
+MicroK
+Multipass
+SREs
+TLS
+Terraform
+Unexpose
+declaratively
+juju
+localhost
+macOS
+natively
+terraform
+unexpose

docs-rtd/.sphinx/.markdownlint.json

@@ -1,16 +1,22 @@
 {
     "default": false,
-    "MD003": { "style": "atx" },
-    "MD013": { "code_blocks": false, "tables": false, "stern": true, "line_length": 150},
+    "MD003": {
+        "style": "atx"
+    },
+    "MD013": false,
     "MD014": true,
     "MD018": true,
     "MD022": true,
     "MD023": true,
-    "MD026": { "punctuation": ".,;。，；"},
-    "MD031": { "list_items": false},
+    "MD026": {
+        "punctuation": ".,;。，；"
+    },
+    "MD031": {
+        "list_items": false
+    },
     "MD032": true,
     "MD035": true,
     "MD042": true,
     "MD045": true,
     "MD052": true
-}
+}

docs-rtd/.sphinx/spellingcheck.yaml

@@ -28,3 +28,4 @@ matrix:
             - img
             - a.p-navigation__link
             - a.contributor
+            - small

docs-rtd/conf.py

@@ -83,8 +83,7 @@
 #
 # TODO: To customise the preview image, update as needed.
 
-ogp_image = \
-    "https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg"
+ogp_image = "https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg"
 
 
 # Product favicon; shown in bookmarks, browser tabs, etc.
@@ -194,7 +193,12 @@
 
 # A regex list of URLs where anchors are ignored by 'make linkcheck'
 
-linkcheck_anchors_ignore_for_url = [r"https://github\.com/.*"]
+linkcheck_anchors_ignore_for_url = [
+    r"https://github\.com/.*",
+    r"https://juju\.is/.*",
+    r"https://matrix\.to/.*",
+    r"https://registry\.terraform\.io/.*",
+]
 
 
 ########################
@@ -207,8 +211,9 @@
 # NOTE: By default, the following MyST extensions are enabled:
 #       substitution, deflist, linkify
 
-# myst_enable_extensions = set()
-
+myst_enable_extensions = {
+    'colon_fence',
+}
 
 # Custom Sphinx extensions; see
 # https://www.sphinx-doc.org/en/master/usage/extensions/index.html
@@ -231,7 +236,6 @@
 extensions = [
     "canonical_sphinx",
     "sphinxcontrib.cairosvgconverter",
-    'sphinx_design',
 ]
 
 

docs-rtd/howto/index.md

@@ -6,7 +6,7 @@
 ```{toctree}
 :maxdepth: 2
 
-Install and manage `terraform-provider-juju` <install-and-manage-terraform-provider-juju>
+Install and manage terraform-provider-juju <install-and-manage-terraform-provider-juju>
 Manage credentials <manage-credentials>
 Manage models <manage-models>
 Manage charms <manage-charms>