change publishing system to mkdocs

.github/workflows/site.yml

@@ -0,0 +1,26 @@
+name: site
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - name: Deploy site
+        run: mkdocs gh-deploy --force

CONTRIBUTING.md

@@ -8,12 +8,7 @@ just a few small guidelines you need to follow.
 Contributions to this project must be accompanied by a Contributor License
 Agreement. You (or your employer) retain the copyright to your contribution;
 this simply gives us permission to use and redistribute your contributions as
-part of the project. Head over to <https://cla.developers.google.com/> to see
-your current agreements on file or to sign a new one.
-
-You generally only need to submit a CLA once, so if you've already submitted one
-(even if it was for a different project), you probably don't need to do it
-again.
+part of the project. 
 
 ## Code reviews
 
@@ -22,7 +17,3 @@ use GitHub pull requests for this purpose. Consult
 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
 information on using pull requests.
 
-## Community Guidelines
-
-This project follows
-[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).

README.md

@@ -1,75 +1,27 @@
 # Polaris Documentation
 
- This **Polaris proposal tool documenation** uses the Docsy
-theme component as a hugo module, together with other module dependencies:
+ This **Polaris proposal tool documentation** uses the mkdocs material theme
 
-```console
-$ hugo mod graph
-hugo: collected modules in 566 ms
-hugo: collected modules in 578 ms
-github.com/google/docsy-example github.com/google/[email protected]
-github.com/google/docsy-example github.com/google/docsy/[email protected]
-github.com/google/docsy/[email protected] github.com/twbs/[email protected]+incompatible
-github.com/google/docsy/[email protected] github.com/FortAwesome/[email protected]
-```
+You can find detailed theme instructions in the [mkdodcs material site](https://squidfunk.github.io/mkdocs-material/).
 
-You can find detailed theme instructions in the [Docsy user guide][].
+## plantuml
 
+```shell
+pip install plantuml-markdown 
+```
 
+https://github.com/neurobin/mdx_include - proper extension structure -> https://github.com/mikitex70/plantuml-markdown need that doing...
 
 ## Running the website locally
 
-Building and running the site locally requires a recent `extended` version of [Hugo](https://gohugo.io).
-You can find out more about how to install Hugo for your environment in our
-[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide.
+Building and running the site locally requires python with the `mkdocs-material`  package installed.
+You can find out more about how to install mkdocs material for your environment in our
+[Getting started](https://squidfunk.github.io/mkdocs-material/getting-started/) guide.
 
 Once you've made your working copy of the site repo, from the repo root folder, run:
 
 ```bash
-hugo server
+mkdocs server
 ```
 
-## Running a container locally
-
-You can run the guide site inside a [Docker](https://docs.docker.com/)
-container, the container runs with a volume bound to the `docsy-example`
-folder. This approach doesn't require you to install any dependencies other
-than [Docker Desktop](https://www.docker.com/products/docker-desktop) on
-Windows and Mac, and [Docker Compose](https://docs.docker.com/compose/install/)
-on Linux.
-
-1. Run the built image
-
-   ```bash
-   docker compose up
-   ```
-
-
-1. Verify that the service is working.
-
-   Open your web browser and type [http://localhost:1313](http://localhost:1313) in your navigation bar,
-   This opens a local instance of the guide homepage. You can now make
-   changes to the guide and those changes will immediately show up in your
-   browser after you save.
-
-### Cleanup
-
-To stop Docker Compose, on your terminal window, press **Ctrl + C**.
-
-To remove the produced images run:
-
-```bash
-docker compose rm
-```
-For more information see the [Docker Compose documentation][].
-
-
-
-[alternate dashboard]: https://app.netlify.com/sites/goldydocs/deploys
-[deploys]: https://app.netlify.com/sites/docsy-example/deploys
-[Docsy user guide]: https://docsy.dev/docs
-[Docsy]: https://github.com/google/docsy
-[example.docsy.dev]: https://example.docsy.dev
-[Hugo theme module]: https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme
-[Netlify]: https://netlify.com
-[Docker Compose documentation]: https://docs.docker.com/compose/gettingstarted/
+and navigate to http://127.0.0.1:8000/