update workflow

mikemorency · Aug 6, 2024 · fb573b8 · fb573b8
1 parent 10d00e4
commit fb573b8
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml
@@ -18,10 +18,11 @@ jobs:
     uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
     with:
       # lenient mode is enabled here because the docs generated from the api spec contain
-      # broken links
+      # broken links. fail-on-error should also be true, but we set it to false for the
+      # same issue
       # see issue https://github.com/ansible-collections/vmware.vmware_rest/issues/509
       init-lenient: true
-      init-fail-on-error: true
+      init-fail-on-error: false
       intersphinx-links: |
         ansible_devel:https://docs.ansible.com/ansible-core/devel/
 

diff --git a/.github/workflows/docs-push.yml b/.github/workflows/docs-push.yml
@@ -9,9 +9,9 @@ on:
       - main
       - stable-*
     tags:
-      - '*'
+      - "*"
   schedule:
-    - cron: '0 12 * * *'
+    - cron: "0 12 * * *"
 
 jobs:
   build-docs:
@@ -20,7 +20,11 @@ jobs:
     name: Build Ansible Docs
     uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-push.yml@main
     with:
-      init-lenient: false
+      # lenient mode is enabled here because the docs generated from the api spec contain
+      # broken links. fail-on-error should also be true, but we set it to false for the
+      # same issue
+      # see issue https://github.com/ansible-collections/vmware.vmware_rest/issues/509
+      init-lenient: true
       init-fail-on-error: true
       intersphinx-links: |
         ansible_devel:https://docs.ansible.com/ansible-core/devel/

diff --git a/docs/docsite/rst/dev_guide.rst b/docs/docsite/rst/dev_guide.rst
@@ -4,7 +4,7 @@
 Guidelines for VMware REST module development
 *********************************************
 
-The Ansible VMware REST collection (on ``Galaxy <https://galaxy.ansible.com/vmware/vmware_rest>``_, source code ``repository <https://github.com/ansible-collections/vmware.vmware_rest>``_) is maintained by Red Hat and the community.
+The Ansible VMware REST collection (on ``Galaxy <https://galaxy.ansible.com/vmware/vmware_rest>``, source code ``repository <https://github.com/ansible-collections/vmware.vmware_rest>``) is maintained by Red Hat and the community.
 
 .. contents::
       :local: