Merge pull request #429 from owasp-noir/add-doc-sitemap

Add-doc-sitemap

.github/workflows/deadlinks.yml

@@ -0,0 +1,30 @@
+---
+    name: DeadLink
+    # Controls when the workflow will run
+    on:
+      # Allows you to run this workflow manually from the Actions tab
+      workflow_dispatch:
+    # A workflow run is made up of one or more jobs that can run sequentially or in parallel
+    jobs:
+      # This workflow contains a single job called "build"
+      build:
+        # The type of runner that the job will run on
+        runs-on: ubuntu-latest
+
+        # Steps represent a sequence of tasks that will be executed as part of the job
+        steps:
+          - name: Find Broken Link
+            uses: hahwul/[email protected]
+            id: broken-link
+            with:
+              command: sitemap
+              target: https://owasp-noir.github.io/noir/sitemap.xml
+          - name: Create an issue
+            uses: dacbd/create-issue-action@main
+            with:
+              token: ${{ github.token }}
+              title: DeadLink Issue
+              body: |
+                ```json
+                ${{ steps.broken-link.outputs.output }}
+                ```

docs/Gemfile

@@ -9,4 +9,5 @@ gem "just-the-docs"
 # Plugins
 group :jekyll_plugins do
   gem "jekyll-securitytxt"
+  gem "jekyll-sitemap"
 end

docs/Gemfile.lock

@@ -46,6 +46,8 @@ GEM
       jekyll
     jekyll-seo-tag (2.8.0)
       jekyll (>= 3.8, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     just-the-docs (0.10.0)
@@ -88,6 +90,7 @@ PLATFORMS
 DEPENDENCIES
   jekyll (~> 4.3.3)
   jekyll-securitytxt
+  jekyll-sitemap
   just-the-docs
 
 BUNDLED WITH

docs/_config.yml

@@ -9,6 +9,9 @@ aux_links:
   Github: https://github.com/owasp-noir/noir
   OWASP: https://owasp.org/www-project-noir/
 
+plugins:
+  - jekyll-sitemap
+
 # Footer "Edit this page on GitHub" link text
 gh_edit_link: true # show or hide edit this page link
 gh_edit_link_text: "Edit this page on GitHub."