From aae91cf71cc5ef59b523ce250aa0241993b54a76 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 18:33:07 -0600 Subject: [PATCH 01/21] Update Dockerfile to use mkdocs-material Update Dockerfile to use mkdocs-material --- Dockerfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index 20cb7d0aa..d589d8ce9 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM ghcr.io/nanocurrency/mkdocs-material-insiders:latest +FROM ghcr.io/nanocurrency/mkdocs-material:latest # Set build directory #WORKDIR /docs @@ -17,4 +17,4 @@ EXPOSE 8000 # Start development server by default ENTRYPOINT ["mkdocs"] -CMD ["serve", "--dev-addr=0.0.0.0:8000"] \ No newline at end of file +CMD ["serve", "--dev-addr=0.0.0.0:8000"] From f75a7267be01683ab70892915def2d88c39f4f72 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 18:42:52 -0600 Subject: [PATCH 02/21] Update build.yml for mkdocs Update build.yml for mkdocs --- .github/workflows/build.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4488046b0..ccd3ab021 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,7 +10,6 @@ jobs: with: python-version: 3.x - run: pip install -r requirements.txt - - run: pip install ${{ secrets.MKDOCS_RESOURCES }} - run: mkdocs build --strict env: From f0fa8e82878eb8e31d9ad0612eba6eab5bc7894c Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 18:43:50 -0600 Subject: [PATCH 03/21] Update requirements.txt with mkdocs & dependencies Update requirements.txt with mkdocs & dependencies --- requirements.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 779d7e323..d8d1135c7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,5 @@ # Direct dependencies -mkdocs-material-extensions>=1.0 -mkdocs-redirects>=1.0.0 \ No newline at end of file +mkdocs>=1.5 +mkdocs-material>=9.4 +mkdocs-material-extensions>=1.3 +mkdocs-redirects>=1.2 From c6f6c2407c9f674ce2ab8138f9b9106f44f5691d Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 18:44:26 -0600 Subject: [PATCH 04/21] Update publish-docker-pr.yml for mkdocs Update publish-docker-pr.yml for mkdocs --- .github/workflows/publish-docker-pr.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish-docker-pr.yml b/.github/workflows/publish-docker-pr.yml index 5da6d78c9..983bc6244 100644 --- a/.github/workflows/publish-docker-pr.yml +++ b/.github/workflows/publish-docker-pr.yml @@ -15,6 +15,6 @@ jobs: # Build and test Docker image - run: | echo ${{ secrets.GHCR_TOKEN }} | docker login ghcr.io -u nanocurrency --password-stdin - docker pull ghcr.io/nanocurrency/mkdocs-material-insiders:latest + docker pull ghcr.io/nanocurrency/mkdocs-material:latest docker build -t ghcr.io/nanocurrency/nano-docs:pr-${{ env.PR_NUMBER }} . - docker push ghcr.io/nanocurrency/nano-docs:pr-${{ env.PR_NUMBER }} \ No newline at end of file + docker push ghcr.io/nanocurrency/nano-docs:pr-${{ env.PR_NUMBER }} From 413cdecaac1b5e2b4eac0f68ce4e475597943b30 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 18:45:09 -0600 Subject: [PATCH 05/21] Update publish-docker-master.yml with mkdocs Update publish-docker-master.yml with mkdocs --- .github/workflows/publish-docker-master.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish-docker-master.yml b/.github/workflows/publish-docker-master.yml index b3b226b5e..49b608e42 100644 --- a/.github/workflows/publish-docker-master.yml +++ b/.github/workflows/publish-docker-master.yml @@ -15,6 +15,6 @@ jobs: # Build and test Docker image - run: | echo ${{ secrets.GHCR_TOKEN }} | docker login ghcr.io -u nanocurrency --password-stdin - docker pull ghcr.io/nanocurrency/mkdocs-material-insiders:latest + docker pull ghcr.io/nanocurrency/mkdocs-material:latest docker build -t ghcr.io/nanocurrency/nano-docs:latest . - docker push ghcr.io/nanocurrency/nano-docs:latest \ No newline at end of file + docker push ghcr.io/nanocurrency/nano-docs:latest From 510532c3a99567594f50db16943060cf395cbec4 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 18:59:31 -0600 Subject: [PATCH 06/21] Update deprecated mkdocs.yml options (#691) Fixing mkdocs build --strict issues: INFO - DeprecationWarning: 'materialx.emoji.twemoji' is deprecated. Material emoji logic has been officially moved into mkdocs-material version 9.4. Please use Material's 'material.extensions.emoji.twemoji' as mkdocs_material_extensions is deprecated and will no longer be supported moving forward. This is the last release. File "/home/default/.local/lib/python3.10/site-packages/materialx/emoji.py", line 106, in twemoji return _patch_index(options) File "/home/default/.local/lib/python3.10/site-packages/materialx/emoji.py", line 59, in _deprecated_func warnings.warn( WARNING - Material emoji logic has been officially moved into mkdocs-material version 9.4. Please use Material's 'material.extensions.emoji.twemoji' as mkdocs_material_extensions is deprecated and will no longer be supported moving forward. This is the last release. WARNING - Config value 'plugins': Plugin 'material/social' option 'cards_color': Deprecated, use 'cards_layout_options.background_color' and 'cards_layout_options.color' with 'default' layout --- mkdocs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 25214ea0d..42dd6fcbe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -121,7 +121,7 @@ markdown_extensions: - pymdownx.critic - pymdownx.details - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji + emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:pymdownx.emoji.to_svg - pymdownx.highlight - pymdownx.inlinehilite @@ -191,9 +191,9 @@ plugins: separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;' - social: cards: !ENV [ PRODUCTION, FALSE ] - cards_color: - fill: "#20204c" - text: "#FFFFFF" + cards_layout_options: + background_color: "#20204c" + color: "#FFFFFF" - redirects: redirect_maps: 'running-a-node/rocksdb-ledger-backend.md': 'running-a-node/ledger-management.md' From a4bcc7973bb3bcba414ff8301091eab6ab547b02 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 19:00:05 -0600 Subject: [PATCH 07/21] Update requirements.txt with material[imaging] Update requirements.txt with material[imaging] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d8d1135c7..13445c0e3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ # Direct dependencies mkdocs>=1.5 -mkdocs-material>=9.4 +mkdocs-material[imaging]>=9.4 mkdocs-material-extensions>=1.3 mkdocs-redirects>=1.2 From 419942fc41e8842b5310607a1a9bbb3fda8f2e47 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 19:05:17 -0600 Subject: [PATCH 08/21] Update publish-docker-pr.yml w/ mkdocs change Testing mkdocs workflow change --- .github/workflows/publish-docker-pr.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-docker-pr.yml b/.github/workflows/publish-docker-pr.yml index 983bc6244..0c1de55c6 100644 --- a/.github/workflows/publish-docker-pr.yml +++ b/.github/workflows/publish-docker-pr.yml @@ -15,6 +15,6 @@ jobs: # Build and test Docker image - run: | echo ${{ secrets.GHCR_TOKEN }} | docker login ghcr.io -u nanocurrency --password-stdin - docker pull ghcr.io/nanocurrency/mkdocs-material:latest + docker pull ghcr.io/nanocurrency/mkdocs-material-insiders:latest docker build -t ghcr.io/nanocurrency/nano-docs:pr-${{ env.PR_NUMBER }} . docker push ghcr.io/nanocurrency/nano-docs:pr-${{ env.PR_NUMBER }} From b8d8dc535c2c77bbc1dc0b07cc2580749b2e2df3 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 19:07:23 -0600 Subject: [PATCH 09/21] Update Dockerfile mkdocs Update Dockerfile mkdocs --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index d589d8ce9..8e0f4e8c4 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM ghcr.io/nanocurrency/mkdocs-material:latest +FROM ghcr.io/nanocurrency/mkdocs-material-insiders:latest # Set build directory #WORKDIR /docs From be54c48339079599231eb7ef4eef7e2e87b1353b Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 19:14:53 -0600 Subject: [PATCH 10/21] Update Dockerfile w/ pip upgrade Update Dockerfile w/ pip upgrade --- Dockerfile | 1 + 1 file changed, 1 insertion(+) diff --git a/Dockerfile b/Dockerfile index 8e0f4e8c4..a51572ff2 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,6 +7,7 @@ FROM ghcr.io/nanocurrency/mkdocs-material-insiders:latest COPY ./ /docs RUN \ + pip install --upgrade pip pip install -r /docs/requirements.txt # Set working directory From 84d45eb7bdcce208c4d1639193edf52344234a1c Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 19:19:02 -0600 Subject: [PATCH 11/21] Update Dockerfile pip commands Update Dockerfile pip commands --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index a51572ff2..11ee86750 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,7 +7,7 @@ FROM ghcr.io/nanocurrency/mkdocs-material-insiders:latest COPY ./ /docs RUN \ - pip install --upgrade pip + pip install --upgrade pip && \ pip install -r /docs/requirements.txt # Set working directory From e1fc7f664233a2eecc8665e96c7e77a9436879d0 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Sun, 19 Nov 2023 21:26:45 -0600 Subject: [PATCH 12/21] Update publish-docker-master.yml Fixing mistake --- .github/workflows/publish-docker-master.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-docker-master.yml b/.github/workflows/publish-docker-master.yml index 49b608e42..3815ac0f5 100644 --- a/.github/workflows/publish-docker-master.yml +++ b/.github/workflows/publish-docker-master.yml @@ -15,6 +15,6 @@ jobs: # Build and test Docker image - run: | echo ${{ secrets.GHCR_TOKEN }} | docker login ghcr.io -u nanocurrency --password-stdin - docker pull ghcr.io/nanocurrency/mkdocs-material:latest + docker pull ghcr.io/nanocurrency/mkdocs-material-insiders:latest docker build -t ghcr.io/nanocurrency/nano-docs:latest . docker push ghcr.io/nanocurrency/nano-docs:latest From b89a12820767e237771450b073a0a8fc610f673b Mon Sep 17 00:00:00 2001 From: qwahzi Date: Mon, 20 Nov 2023 14:34:40 -0600 Subject: [PATCH 13/21] Remove extra pip install on deploy-staging.yml Remove extra pip install on deploy-staging.yml to mirror the publish workflows --- .github/workflows/deploy-staging.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/deploy-staging.yml b/.github/workflows/deploy-staging.yml index 13e56b8c7..c00019bdb 100644 --- a/.github/workflows/deploy-staging.yml +++ b/.github/workflows/deploy-staging.yml @@ -19,7 +19,6 @@ jobs: key: ${{ github.ref }} path: .cache - run: pip install -r requirements.txt - - run: pip install ${{ secrets.MKDOCS_RESOURCES }} - run: mkdocs gh-deploy --force env: GH_TOKEN: ${{ secrets.GH_TOKEN }} From 75ef6825774ee96486262393908cf40c58a04b1a Mon Sep 17 00:00:00 2001 From: qwahzi Date: Mon, 20 Nov 2023 14:35:24 -0600 Subject: [PATCH 14/21] Remove extra pip install on deploy.yml Remove extra pip install on deploy.yml to mirror publish workflows --- .github/workflows/deploy.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 2cad883ee..a93f45ad9 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -18,7 +18,6 @@ jobs: key: ${{ github.ref }} path: .cache - run: pip install -r requirements.txt - - run: pip install ${{ secrets.MKDOCS_RESOURCES }} - run: mkdocs gh-deploy --force env: GH_TOKEN: ${{ secrets.GH_TOKEN }} From 635eaa8f50197b7e2d6e3eaf16a021f022ef66f0 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Wed, 22 Nov 2023 11:59:04 -0600 Subject: [PATCH 15/21] Update Dockerfile to squidfunk/mkdocs-material Update Dockerfile to squidfunk/mkdocs-material --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 11ee86750..43a47c7e8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM ghcr.io/nanocurrency/mkdocs-material-insiders:latest +FROM squidfunk/mkdocs-material:latest # Set build directory #WORKDIR /docs From f75977200ad41780cb75246682348e77095c3cc8 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Wed, 22 Nov 2023 12:00:36 -0600 Subject: [PATCH 16/21] Update publish-docker-master.yml with squidfunk/mkdocs-material:latest Update publish-docker-master.yml with squidfunk/mkdocs-material:latest --- .github/workflows/publish-docker-master.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-docker-master.yml b/.github/workflows/publish-docker-master.yml index 3815ac0f5..8f634405f 100644 --- a/.github/workflows/publish-docker-master.yml +++ b/.github/workflows/publish-docker-master.yml @@ -15,6 +15,6 @@ jobs: # Build and test Docker image - run: | echo ${{ secrets.GHCR_TOKEN }} | docker login ghcr.io -u nanocurrency --password-stdin - docker pull ghcr.io/nanocurrency/mkdocs-material-insiders:latest + docker pull squidfunk/mkdocs-material:latest docker build -t ghcr.io/nanocurrency/nano-docs:latest . docker push ghcr.io/nanocurrency/nano-docs:latest From c32cddbb222fad893b66eb7f2b42386deebd53a1 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Wed, 22 Nov 2023 12:01:12 -0600 Subject: [PATCH 17/21] Update publish-docker-pr.yml with Update publish-docker-master.yml with squidfunk/mkdocs-material:latest Update publish-docker-pr.yml with Update publish-docker-master.yml with squidfunk/mkdocs-material:latest --- .github/workflows/publish-docker-pr.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-docker-pr.yml b/.github/workflows/publish-docker-pr.yml index 0c1de55c6..2500095c2 100644 --- a/.github/workflows/publish-docker-pr.yml +++ b/.github/workflows/publish-docker-pr.yml @@ -15,6 +15,6 @@ jobs: # Build and test Docker image - run: | echo ${{ secrets.GHCR_TOKEN }} | docker login ghcr.io -u nanocurrency --password-stdin - docker pull ghcr.io/nanocurrency/mkdocs-material-insiders:latest + docker pull squidfunk/mkdocs-material:latest docker build -t ghcr.io/nanocurrency/nano-docs:pr-${{ env.PR_NUMBER }} . docker push ghcr.io/nanocurrency/nano-docs:pr-${{ env.PR_NUMBER }} From 7bb116ef3cef539f3d8a30e99420a99d3cc2c664 Mon Sep 17 00:00:00 2001 From: qwahzi Date: Wed, 22 Nov 2023 12:08:25 -0600 Subject: [PATCH 18/21] Remove old theme info from readme.md Remove old theme info from readme.md --- readme.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/readme.md b/readme.md index 5391f13b7..e6ebc6f24 100644 --- a/readme.md +++ b/readme.md @@ -35,12 +35,6 @@ Note that because a local volume isn't being mounted this pull request review ap Access the site at http://localhost:8000. This supports automatic rebuilding, so anytime changes are saved to the documentation or configuration, it will be rebuilt and refresh the page. Some search indexing may remain cache between builds. -## Theme - -We sponsor the developer of this theme on GitHub ([@squidfunk](https://github.com/squidfunk)) in order to get access to special features of the [Insiders](https://squidfunk.github.io/mkdocs-material-insiders/) version. Our [@nano-infrastructure](https://github.com/nano-infrastructure) account has the permissions to the private repository for that Insiders theme and using a personal access token in the GitHub deployment workflow (set as a GitHub secret in this repository), the theme is pulled down as part of deployment. - -Those developing locally may not have access to some of the special features of this insider theme, but most changes done by external contributors do not need the special theme - changes are backwards compatible with the regular theme. If you need access to the Insiders theme please contact the Nano core team. - ## Formatting and Organization Tips ## Title and description From 355b5ed6ac0fab39a461b9ca2580c5863e93b6bf Mon Sep 17 00:00:00 2001 From: qwahzi Date: Wed, 22 Nov 2023 12:47:11 -0600 Subject: [PATCH 19/21] Update Dockerfile to use digest Update Dockerfile to use digest --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 43a47c7e8..013d790c7 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM squidfunk/mkdocs-material:latest +FROM squidfunk/mkdocs-material:9.4.10@sha256:01605a03397a654b74b9de3157f56915d1e075e2d3bd22fcf3fb82c443553c25 # Set build directory #WORKDIR /docs From 07ed1ad7669eb8da49eff68b6d085503894927cf Mon Sep 17 00:00:00 2001 From: qwahzi Date: Wed, 22 Nov 2023 12:48:03 -0600 Subject: [PATCH 20/21] Update publish-docker-pr.yml to use digest Update image to use digest --- .github/workflows/publish-docker-pr.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-docker-pr.yml b/.github/workflows/publish-docker-pr.yml index 2500095c2..5e62b68dd 100644 --- a/.github/workflows/publish-docker-pr.yml +++ b/.github/workflows/publish-docker-pr.yml @@ -15,6 +15,6 @@ jobs: # Build and test Docker image - run: | echo ${{ secrets.GHCR_TOKEN }} | docker login ghcr.io -u nanocurrency --password-stdin - docker pull squidfunk/mkdocs-material:latest + docker pull squidfunk/mkdocs-material:9.4.10@sha256:01605a03397a654b74b9de3157f56915d1e075e2d3bd22fcf3fb82c443553c25 docker build -t ghcr.io/nanocurrency/nano-docs:pr-${{ env.PR_NUMBER }} . docker push ghcr.io/nanocurrency/nano-docs:pr-${{ env.PR_NUMBER }} From 533b7c1abea91cdbd2f3752ebf9f2f830695084f Mon Sep 17 00:00:00 2001 From: qwahzi Date: Wed, 22 Nov 2023 12:48:28 -0600 Subject: [PATCH 21/21] Update publish-docker-master.yml to use digest Use sha256 digest --- .github/workflows/publish-docker-master.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-docker-master.yml b/.github/workflows/publish-docker-master.yml index 8f634405f..669abdfc2 100644 --- a/.github/workflows/publish-docker-master.yml +++ b/.github/workflows/publish-docker-master.yml @@ -15,6 +15,6 @@ jobs: # Build and test Docker image - run: | echo ${{ secrets.GHCR_TOKEN }} | docker login ghcr.io -u nanocurrency --password-stdin - docker pull squidfunk/mkdocs-material:latest + docker pull squidfunk/mkdocs-material:9.4.10@sha256:01605a03397a654b74b9de3157f56915d1e075e2d3bd22fcf3fb82c443553c25 docker build -t ghcr.io/nanocurrency/nano-docs:latest . docker push ghcr.io/nanocurrency/nano-docs:latest