Use mkdocs version

.github/ISSUE_TEMPLATE/add-project-logo-or-image-to-your-main-repository.md

@@ -8,11 +8,11 @@ assignees: ''
 
 ### Overview
 
-By adding the project's logo/image to your project's primary repository, we will be able to dynamically deliver up to date information about your project to the hackforla.org website.  Also when people add the link to the repository in LinkedIn or Slack, or other social media it will automatically use the image as well as the description, improving the link's chances of getting clicked on.
+By adding the project's logo/image to your project's primary repository, we will be able to dynamically deliver up to date information about your project to the hackforla.org website. Also when people add the link to the repository in LinkedIn or Slack, or other social media it will automatically use the image as well as the description, improving the link's chances of getting clicked on.
 
 ### Action Items
 
-Add project's logo/image to your primary Github repository using the instructions below.  You should use the same image as is on the hackforla.org website, or if another image is desired, please replace both with the same image.
+Add project's logo/image to your primary Github repository using the instructions below. You should use the same image as is on the hackforla.org website, or if another image is desired, please replace both with the same image.
 
 ### Resources/Instructions
 

.github/ISSUE_TEMPLATE/blank-issue.md

@@ -14,7 +14,7 @@ REPLACE THIS TEXT -Text here that clearly states the purpose of this issue in 2
 
 REPLACE THIS TEXT -If this is the beginning of the task this is most likely something to be researched and documented.
 
-REPLACE THIS TEXT -If the issue has already been researched, and the course of action is clear, this will describe the steps.  However, if the steps can be divided into tasks for more than one person, we recommend dividing it up into separate issues, or assigning it as a pair programming task.
+REPLACE THIS TEXT -If the issue has already been researched, and the course of action is clear, this will describe the steps. However, if the steps can be divided into tasks for more than one person, we recommend dividing it up into separate issues, or assigning it as a pair programming task.
 
 ### Resources/Instructions
 

.github/ISSUE_TEMPLATE/control-what-appears-when-you-paste-your-sites-link-in-social-media-sites.md

@@ -14,12 +14,11 @@ When your website is shared on slack, facebook, twitter, etc. It should automati
 
 Identify what to put in the following fields:
 og:url
-g:type
 og:title
-og:description     
-og:image   
+og:description
+og:image
 og:type (optional)
-og:local (option)
+og:locale (optional)
 using the standards set forth in the instructions.
 
 Add content to header and test with the tool provided in the instructions.

.github/ISSUE_TEMPLATE/create-agenda.md

@@ -25,11 +25,11 @@ This issue tracks the agenda for our weekly meetings
        - [ ] [Name of Person]
 - [ ] finish adding labels to the issue that are still missing them (see audit links above)
 - [ ] review issues with [epic label] and define how to break down further
-- [ ] Review to see if there are any members to Onboard or Offboard 
+- [ ] Review to see if there are any members to Onboard or Offboard
       - [ ]  #
 
 ### New Items
-- [ ] 
+- [ ]
 - [ ] Carry over Items to next meeting that don't get addressed
 
 ### FYIs

.github/ISSUE_TEMPLATE/lighthouse--accessibility---forms.md

@@ -11,7 +11,7 @@ assignees: ''
 
 ### Overview
 
-In order for your sites form(s) to be usable by visitors using screen readers all the form <input> elements need labels.  There are specific details and exceptions, which can be found in the instructions below.
+In order for your sites form(s) to be usable by visitors using screen readers all the form <input> elements need labels. There are specific details and exceptions, which can be found in the instructions below.
 
 ### Action Items
 

.github/ISSUE_TEMPLATE/lighthouse--accessibility---links.md

@@ -8,7 +8,7 @@ assignees: ''
 
 ### Overview
 
-The formatting of links can make them readable or unreadable by screen readers.  Which includes creating programmatic events for links without making them device specific (e.g., onfocus() instead of onmouseover(), etc.), and other ways of making sure all links are visible by screen readers.
+The formatting of links can make them readable or unreadable by screen readers. Which includes creating programmatic events for links without making them device specific (e.g., onfocus() instead of onmouseover(), etc.), and other ways of making sure all links are visible by screen readers.
 
 ### Action Items
 

.github/ISSUE_TEMPLATE/lighthouse--cross-origin-destinations-are-unsafe.md

@@ -12,7 +12,7 @@ Links to cross-origin destinations are unsafe both from a security and performan
 
 ### Action Item
 
-Run [Lighthouse](https://developers.google.com/web/tools/lighthouse/) and then follow the instructions in \[cross-origin destinations are unsafe\]
+Run [Lighthouse](https://developers.google.com/web/tools/lighthouse/) and then follow the instructions in [cross-origin destinations are unsafe]
 (https://developers.google.com/web/tools/lighthouse/audits/noopener) .
 
 ## Summary of instructions

.github/ISSUE_TEMPLATE/lighthouse--how-to.md

@@ -8,7 +8,7 @@ assignees: ''
 
 ### Overview
 
-Lighthouse is an open-source, automated tool for improving the quality of web pages. You can run it against any web page, public or requiring authentication. It has audits for performance, accessibility, progressive web apps, and more.  Hack For LA recommends that you run the tests and evaluate what changes you might want to make on your website to improve performance and accessability.
+Lighthouse is an open-source, automated tool for improving the quality of web pages. You can run it against any web page, public or requiring authentication. It has audits for performance, accessibility, progressive web apps, and more. Hack For LA recommends that you run the tests and evaluate what changes you might want to make on your website to improve performance and accessability.
 
 ### How To Use
 
@@ -26,4 +26,4 @@ https://developers.google.com/web/tools/lighthouse/
 
 ### Tip
 
-You will want to re-run lighthouse on any code changes before integrating them into your site.  Sometimes the specific suggestions it makes, do not actually result in improved performance or can actually harm performance.
+You will want to re-run lighthouse on any code changes before integrating them into your site. Sometimes the specific suggestions it makes, do not actually result in improved performance or can actually harm performance.

.github/ISSUE_TEMPLATE/onboard---offboard--product.md

@@ -16,7 +16,7 @@ We need to have a checklist of items to do when a product manager onboard and of
 
 ### Action Items
 
-- [ ] Check to see if the org template for this process has new steps in it, and if it does, update this  issue and its template with content and add the last date you updated the template below
+- [ ] Check to see if the org template for this process has new steps in it, and if it does, update this issue and its template with content and add the last date you updated the template below
 - [ ] Copy template to comment below
 - [ ] Add name of person
 - [ ] Check off as done
@@ -48,7 +48,7 @@ We need to have a checklist of items to do when a product manager onboard and of
 - [ ] Figma
   - [ ] invite
   - [ ] acceptance
-- [ ] 1password 
+- [ ] 1password
      - [ ] invitation
      - [ ] acceptance
      - [ ] add to vaults
@@ -60,7 +60,7 @@ We need to have a checklist of items to do when a product manager onboard and of
    - [ ] [REPLACE with name of secondary email]
 - [ ] Social Media Accounts with role assignment
    - [ ] Facebook
-- [ ] Train how to 
+- [ ] Train how to
    - [ ] login to team account
    - [ ] setup chrome shortcut for adding to desktop
    - [ ] use zoom spreadsheet, vault and accounts
@@ -105,15 +105,15 @@ We need to have a checklist of items to do when a product manager onboard and of
 - [REPLACE with Team Roster]
 - Check public and 2FA at [people page](https://github.com/orgs/hackforla/people)
 - [REPLACE with GitHub Team URL]
-   - [base (read)]
-   - [write]
-   - [maintain]
-   - [triage]
-   - [admin]
-   - [other]
-- WIKI team page: https://github.com/hackforla/[Replace with name of your project]/wiki/The-Team
+    - [base (read)]
+    - [write]
+    - [maintain]
+    - [triage]
+    - [admin]
+    - [other]
+- WIKI team page: https://github.com/hackforla/[Replace with name of your project\]/wiki/The-Team
 - [Replace with name of your project Figma]
-- Shortcut for adding a profile to the desktop:  chrome://settings/manageProfile
+- Shortcut for adding a profile to the desktop: chrome://settings/manageProfile
 - Tutorials
     - [Forward emails to team members](https://github.com/hackforla/product-management/wiki/Forward-emails-to-team-members)
 

.github/ISSUE_TEMPLATE/proposal-to-change-project-md-file-format.md

@@ -26,7 +26,7 @@ Describe the purpose for the proposal change
 
 - [ ] Update Template project.md wiki page
 
-- [ ] Submit pull request - indicating Issue #294 is affected (format changes log), and the text "fixes Issue #\[number that you are creating now\]
+- [ ] Submit pull request - indicating Issue #294 is affected (format changes log), and the text "fixes Issue #[number that you are creating now]
 
 ### Resources
 

.github/ISSUE_TEMPLATE/update-project-profile---name-of-project-.md

@@ -1,7 +1,6 @@
 ---
 name: 'Update Project Profile: \[name of project\]'
-about: We are making a project home page for each project and need some additional
-  info
+about: We are making a project home page for each project and need some additional info
 title: 'Update Project Profile: \[name of project\]'
 labels: documentation
 assignees: ''

.github/ISSUE_TEMPLATE/which-accessibility-testing-tool-should-you-use-.md

@@ -11,7 +11,7 @@ assignees: ''
 
 ### Overview
 
-There are more than 100 accessibility testing tools.  Figuring out which ones to use can be a black hole.  For guidance we recommend this article:  [Which accessibility testing tool should you use?](https://medium.com/pulsar/which-accessibility-testing-tool-should-you-use-e5990e6ef0a)
+There are more than 100 accessibility testing tools. Figuring out which ones to use can be a black hole. For guidance we recommend this article: [Which accessibility testing tool should you use?](https://medium.com/pulsar/which-accessibility-testing-tool-should-you-use-e5990e6ef0a)
 
 ### Summary of Article
 

.github/workflows/build-image.yml

@@ -4,9 +4,9 @@ on:
   push:
     branches: main
     paths:
-      - 'Dockerfile'
-      - 'requirements.txt'
-      - '.dockerignore'
+      - "Dockerfile"
+      - "requirements.txt"
+      - ".dockerignore"
 
 jobs:
   push_to_registry:
@@ -23,10 +23,16 @@ jobs:
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_TOKEN }}
+      - name: Extract MkDocs version
+        id: extract_mkdocs_version
+        run: |
+          mkdocs_version=$(grep -oP 'mkdocs-material==\K[0-9.]+(?=\s)' requirements.txt)
+          echo "version=$mkdocs_version" >> $GITHUB_ENV
       - name: Build and push
         uses: docker/build-push-action@v5
         with:
           context: .
           platforms: linux/amd64,linux/arm64
           push: true
-          tags: ${{ secrets.DOCKER_USERNAME }}/mkdocs:latest
+          tags: |
+            ${{ secrets.DOCKER_USERNAME }}/mkdocs:${{ steps.extract_mkdocs_version.outputs.version.outputs.version }}

.github/workflows/deploy-docs.yml

@@ -21,6 +21,6 @@ jobs:
           restore-keys: |
             mkdocs-material-
       - run: pip install \
-          mkdocs-material==9.1.17 \
+          mkdocs-material==9.5.33 \
           mkdocs-autolinks-plugin==0.7.1
       - run: mkdocs gh-deploy --force

.github/workflows/pull-request.yml

@@ -0,0 +1,21 @@
+name: PR Checks
+
+on:
+  pull_request:
+
+jobs:
+  Audit-Pull-Request:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Validate mkdocs
+        run: mkdocs build --strict

.gitignore

@@ -1,3 +1,4 @@
 __pycache__/
 *.py[cod]
 *.sw*
+site/

.pre-commit-config.yaml

@@ -0,0 +1,84 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_install_hook_types: [pre-commit, pre-push]
+default_stages: [pre-commit, pre-push]
+default_language_version:
+  python: python3.12
+minimum_pre_commit_version: "2.18"
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      # identify invalid files
+    -   id: check-yaml
+        args: [--unsafe]
+    -   id: check-toml
+    -   id: check-executables-have-shebangs
+    -   id: check-shebang-scripts-are-executable
+
+      # git checks
+    -   id: check-merge-conflict
+    -   id: check-added-large-files
+    -   id: detect-private-key
+    -   id: check-case-conflict
+
+      # general quality checks
+    -   id: mixed-line-ending
+    -   id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+    -   id: check-executables-have-shebangs
+    -   id: end-of-file-fixer
+
+-   repo: https://github.com/AleksaC/hadolint-py
+    rev: v2.12.0.3
+    hooks:
+    -   id: hadolint
+
+-   repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+    -   id: shellcheck
+
+-   repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.22
+    hooks:
+    -   id: mdformat
+        additional_dependencies:
+        -   mdformat-mkdocs[recommended]>=4.1.2
+
+-   repo: https://gitlab.com/vojko.pribudic.foss/pre-commit-update
+    rev: v0.8.0
+    hooks:
+    -   id: pre-commit-update
+
+-   repo: https://github.com/python-poetry/poetry
+    rev: 2.1.3
+    hooks:
+    -   id: poetry-check
+    -   id: poetry-lock
+
+
+-   repo: https://github.com/python-poetry/poetry-plugin-export
+    rev: 1.9.0
+    hooks:
+    -   id: poetry-export
+
+-   repo: https://github.com/mxr/sync-pre-commit-deps
+    rev: v0.0.3
+    hooks:
+    -   id: sync-pre-commit-deps
+
+-   repo: local
+    hooks:
+    -   id: test
+        name: test
+        entry: ./scripts/validate_mkdocs.sh
+        language: system
+        pass_filenames: false
+        always_run: true
+        # verbose: true
+        # require_serial: true
+        stages: [pre-push]
+
+ci:
+  autoupdate_schedule: quarterly

Dockerfile

@@ -2,7 +2,7 @@
 # we need at least syntax version 1.3 for the cache mount. 1 will use the latest 1.x version syntax
 
 # pull official base image
-FROM python:3.11-alpine3.18
+FROM python:3.12-alpine
 
 # set work directory
 WORKDIR /app
@@ -22,6 +22,7 @@ ENV PYTHONUNBUFFERED=1 \
 
 # install dependencies
 COPY requirements.txt .
+# hadolint ignore=DL3042
 RUN \
   --mount=type=cache,target=/root/.cache \
   pip install -r requirements.txt

docker-compose.yml

@@ -1,4 +1,3 @@
-version: "3.9"
 services:
   mkdocs:
     image: hackforlaops/mkdocs:testing