Merge pull request ansible-collections#21 from alinabuzachis/docs_wor…

…kflow Add docs validation workflows
goneri · Aug 17, 2022 · 273cd55 · 273cd55
2 parents 30d9694 + 1f166a2
commit 273cd55
Show file tree

Hide file tree

Showing 25 changed files with 110 additions and 163 deletions.
diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml
@@ -0,0 +1,63 @@
+name: Collection Docs
+concurrency:
+  group: docs-${{ github.head_ref }}
+  cancel-in-progress: true
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened, closed]
+
+jobs:
+  validate-docs:
+    permissions:
+      contents: read
+    name: Validate Ansible Docs
+    uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
+    with:
+      init-lenient: false
+      init-fail-on-error: true
+      extra-collections: 'amazon.aws'
+
+
+  build-docs:
+    permissions:
+      contents: read
+    name: Build Ansible Docs
+    uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
+    with:
+      init-lenient: true
+      init-fail-on-error: false
+      extra-collections: 'amazon.aws'
+
+  comment:
+    permissions:
+      pull-requests: write
+    runs-on: ubuntu-latest
+    needs: [build-docs]
+    name: PR comments
+    steps:
+      - name: PR comment
+        uses: ansible-community/github-docs-build/actions/ansible-docs-build-comment@main
+        with:
+          body-includes: '## Docs Build'
+          reactions: heart
+          action: ${{ needs.build-docs.outputs.changed != 'true' && 'remove' || '' }}
+          on-closed-action: remove
+          on-merged-body: |
+            ## Docs Build 📝
+
+            Thank you for contribution!✨
+
+            This PR has been merged and your docs changes will be incorporated when they are next published.
+          body: |
+            ## Docs Build 📝
+
+            Thank you for contribution!✨
+
+            The docsite for **this PR** is available for download as an artifact from this run:
+            ${{ needs.build-docs.outputs.artifact-url }}
+
+            File changes:
+
+            ${{ needs.build-docs.outputs.diff-files-rendered }}
+
+            ${{ needs.build-docs.outputs.diff-rendered }}
diff --git a/docs/docsite/rst/guide_amazon_cloud.rst b/docs/docsite/rst/guide_amazon_cloud.rst
@@ -1,8 +1,8 @@
 .. _ansible_collections.amazon.cloud.docsite.aws_intro:
 
-*************************
+*****************************
 Amazon.Cloud Collection Guide
-*************************
+*****************************
 
 The AWS Cloud Control Collection ``amazon.cloud`` is an experimental alpha collection that contains a number of generated modules using the Cloud Control API for controlling Amazon Web Services (AWS). This guide explains how to use the modules to automate your AWS resources with Ansible.
 

diff --git a/plugins/doc_fragments/aws.py b/plugins/doc_fragments/aws.py
diff --git a/plugins/doc_fragments/ec2.py b/plugins/doc_fragments/ec2.py
diff --git a/plugins/modules/backup_backup_vault.py b/plugins/modules/backup_backup_vault.py
@@ -112,8 +112,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/backup_framework.py b/plugins/modules/backup_framework.py
@@ -66,7 +66,7 @@
                     compliance_resource_types:
                         description:
                         - Describes whether the control scope includes one or more
-                            types of resources, such as `EFS` or `RDS`.
+                            types of resources, such as EFS or RDS.
                         elements: str
                         type: list
                     tags:
@@ -177,8 +177,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/backup_report_plan.py b/plugins/modules/backup_report_plan.py
@@ -99,8 +99,8 @@
                 description:
                 - Identifies the report template for the report.
                 - Reports are built using a report template.
-                - 'The report templates are: `C(BACKUP_JOB_REPORT) | C(COPY_JOB_REPORT)
-                    | C(RESTORE_JOB_REPORT)`'
+                - 'The report templates are: C(BACKUP_JOB_REPORT) | C(COPY_JOB_REPORT)
+                    | C(RESTORE_JOB_REPORT)'
                 required: true
                 type: str
         type: dict
@@ -142,8 +142,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/eks_cluster.py b/plugins/modules/eks_cluster.py
@@ -212,8 +212,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/iam_role.py b/plugins/modules/iam_role.py
@@ -112,8 +112,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/lambda_code_signing_config.py b/plugins/modules/lambda_code_signing_config.py
@@ -86,8 +86,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/lambda_event_source_mapping.py b/plugins/modules/lambda_event_source_mapping.py
@@ -196,8 +196,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/lambda_function.py b/plugins/modules/lambda_function.py
@@ -268,8 +268,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/logs_log_group.py b/plugins/modules/logs_log_group.py
@@ -94,8 +94,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/logs_query_definition.py b/plugins/modules/logs_query_definition.py
@@ -66,8 +66,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/logs_resource_policy.py b/plugins/modules/logs_resource_policy.py
@@ -57,8 +57,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/rdsdb_proxy.py b/plugins/modules/rdsdb_proxy.py
@@ -145,8 +145,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/redshift_cluster.py b/plugins/modules/redshift_cluster.py
@@ -342,8 +342,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/redshift_event_subscription.py b/plugins/modules/redshift_event_subscription.py
@@ -111,8 +111,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/s3_access_point.py b/plugins/modules/s3_access_point.py
@@ -137,8 +137,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""

diff --git a/plugins/modules/s3_bucket.py b/plugins/modules/s3_bucket.py
@@ -1363,8 +1363,8 @@
 version_added: 0.1.0
 requirements: []
 extends_documentation_fragment:
-- amazon.cloud.aws
-- amazon.cloud.ec2
+- amazon.aws.aws
+- amazon.aws.ec2
 """
 
 EXAMPLES = r"""