update docs for release (#99)

* update docs * .
ofek · May 14, 2022 · 95b8db4 · 95b8db4
1 parent 896d9d8
commit 95b8db4
Show file tree

Hide file tree

Showing 15 changed files with 87 additions and 55 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,4 @@
+github:
+- ofek
+custom:
+- https://ofek.dev/donate/
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,4 +1,4 @@
-name: Documentation
+name: documentation
 
 on:
   create:

diff --git a/.github/workflows/image.yml b/.github/workflows/image.yml
@@ -1,4 +1,4 @@
-name: Image
+name: image
 
 on: [push, pull_request]
 

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,4 +1,4 @@
-name: Test
+name: test
 
 on: [push, pull_request]
 

diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
 # csi-gcs
 
-[![CI - Image](https://github.com/ofek/csi-gcs/workflows/Image/badge.svg)](https://github.com/ofek/csi-gcs/actions?query=workflow%3AImage)
-[![CI - Test](https://github.com/ofek/csi-gcs/workflows/Test/badge.svg)](https://github.com/ofek/csi-gcs/actions?query=workflow%3ATest)
-[![CI - Documentation](https://github.com/ofek/csi-gcs/workflows/Documentation/badge.svg)](https://github.com/ofek/csi-gcs/actions?query=workflow%3ADocumentation)
-[![Docker - Pulls](https://img.shields.io/docker/pulls/ofekmeister/csi-gcs.svg)](https://hub.docker.com/r/ofekmeister/csi-gcs)
-[![License - MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-9400d3.svg)](https://choosealicense.com/licenses)
-[![Say Thanks](https://img.shields.io/badge/say-thanks-ff69b4.svg)](https://saythanks.io/to/ofekmeister%40gmail.com)
+| | |
+| --- | --- |
+| CI/CD | [![CI - Test](https://github.com/ofek/csi-gcs/actions/workflows/test.yml/badge.svg)](https://github.com/ofek/csi-gcs/actions/workflows/test.yml) [![CI - Image](https://github.com/ofek/csi-gcs/actions/workflows/image.yml/badge.svg)](https://github.com/ofek/csi-gcs/actions/workflows/image.yml) |
+| Docs | [![Docs](https://github.com/ofek/csi-gcs/actions/workflows/docs.yml/badge.svg)](https://github.com/ofek/csi-gcs/actions/workflows/docs.yml) |
+| Image | [![Docker - Version](https://img.shields.io/docker/v/ofekmeister/csi-gcs.svg?sort=semver)](https://hub.docker.com/r/ofekmeister/csi-gcs) [![Docker - Pulls](https://img.shields.io/docker/pulls/ofekmeister/csi-gcs.svg)](https://hub.docker.com/r/ofekmeister/csi-gcs) |
+| Meta | [![License - MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-9400d3.svg)](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/ofek?logo=GitHub%20Sponsors&style=social)](https://github.com/sponsors/ofek) |
 
 -----
 

diff --git a/docs/assets/css/custom.css b/docs/assets/css/custom.css
@@ -1,11 +1,11 @@
-.md-typeset .tabbed-set {
-  border: 1px solid #eee;
-}
-.md-typeset .tabbed-content {
-  padding: 0.5em 1em;
-}
-
+/* https://github.com/squidfunk/mkdocs-material/issues/1522 */
 .md-typeset h5 {
   color: var(--md-default-fg-color);
   text-transform: none;
 }
+
+/* Brighter links for dark mode */
+[data-md-color-scheme=slate] {
+  /* https://github.com/squidfunk/mkdocs-material/blob/8.2.15/src/assets/stylesheets/main/_colors.scss */
+  --md-typeset-a-color: var(--md-primary-fg-color--light);
+}
diff --git a/docs/assets/js/custom.js b/docs/assets/js/custom.js
diff --git a/docs/contributing/authors.md b/docs/contributing/authors.md
@@ -4,12 +4,12 @@
 
 ## Maintainers
 
-- Ofek Lev [:octicons-octoface:](https://github.com/ofek) [:material-twitter:](https://twitter.com/Ofekmeister)
-- Jonatan Männchen [:octicons-octoface:](https://github.com/maennchen)
+- Ofek Lev [:material-web:](https://ofek.dev) [:material-github:](https://github.com/ofek) [:material-twitter:](https://twitter.com/Ofekmeister)
+- Jonatan Männchen [:material-github:](https://github.com/maennchen)
 
 ## Contributors
 
-- Ofek Lev [:octicons-octoface:](https://github.com/ofek) [:material-twitter:](https://twitter.com/Ofekmeister)
-- Jonatan Männchen [:octicons-octoface:](https://github.com/maennchen)
-- Joel Cressy [:octicons-octoface:](https://github.com/jtcressy) [:material-twitter:](https://twitter.com/jtcressy)
-- Alex Khaerov [:octicons-octoface:](https://github.com/hayorov) [:material-twitter:](https://twitter.com/hayorov)
+- Ofek Lev [:material-github:](https://github.com/ofek) [:material-twitter:](https://twitter.com/Ofekmeister)
+- Jonatan Männchen [:material-github:](https://github.com/maennchen)
+- Joel Cressy [:material-github:](https://github.com/jtcressy) [:material-twitter:](https://twitter.com/jtcressy)
+- Alex Khaerov [:material-github:](https://github.com/hayorov) [:material-twitter:](https://twitter.com/hayorov)
diff --git a/docs/contributing/setup.md b/docs/contributing/setup.md
@@ -104,6 +104,4 @@ Run all `invoke` commands through `invoke env -c "[CMD]"`.
 
 If any changes are made in the `pkg/apis` package, the `pkg/client` needs to be regenerated.
 
-To do this, the project has to be checked out in the `$GOPATH/src/github.com/ofek/csi-gcs` directory, since [K8S Codegen](https://github.com/kubernetes/code-generator) is not working with Go Modules properly. See https://github.com/kubernetes/kubernetes/issues/82531
-
-To regenerate the client package, run `./hack/update-codegen.sh`.
+To regenerate the client package, run `invoke codegen`.
diff --git a/docs/index.md b/docs/index.md
@@ -1,11 +1,11 @@
 # csi-gcs
 
-[![CI - Image](https://github.com/ofek/csi-gcs/workflows/Image/badge.svg)](https://github.com/ofek/csi-gcs/actions?query=workflow%3AImage)
-[![CI - Test](https://github.com/ofek/csi-gcs/workflows/Test/badge.svg)](https://github.com/ofek/csi-gcs/actions?query=workflow%3ATest)
-[![CI - Documentation](https://github.com/ofek/csi-gcs/workflows/Documentation/badge.svg)](https://github.com/ofek/csi-gcs/actions?query=workflow%3ADocumentation)
-[![Docker - Pulls](https://img.shields.io/docker/pulls/ofekmeister/csi-gcs.svg)](https://hub.docker.com/r/ofekmeister/csi-gcs)
-[![License - MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-9400d3.svg)](https://choosealicense.com/licenses)
-[![Say Thanks](https://img.shields.io/badge/say-thanks-ff69b4.svg)](https://saythanks.io/to/ofekmeister%40gmail.com)
+| | |
+| --- | --- |
+| CI/CD | [![CI - Test](https://github.com/ofek/csi-gcs/actions/workflows/test.yml/badge.svg){ loading=lazy }](https://github.com/ofek/csi-gcs/actions/workflows/test.yml) [![CI - Image](https://github.com/ofek/csi-gcs/actions/workflows/image.yml/badge.svg){ loading=lazy }](https://github.com/ofek/csi-gcs/actions/workflows/image.yml) |
+| Docs | [![Docs](https://github.com/ofek/csi-gcs/actions/workflows/docs.yml/badge.svg){ loading=lazy }](https://github.com/ofek/csi-gcs/actions/workflows/docs.yml) |
+| Image | [![Docker - Version](https://img.shields.io/docker/v/ofekmeister/csi-gcs.svg?sort=semver){ loading=lazy }](https://hub.docker.com/r/ofekmeister/csi-gcs) [![Docker - Pulls](https://img.shields.io/docker/pulls/ofekmeister/csi-gcs.svg){ loading=lazy }](https://hub.docker.com/r/ofekmeister/csi-gcs) |
+| Meta | [![License - MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-9400d3.svg){ loading=lazy }](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/github/sponsors/ofek?logo=GitHub%20Sponsors&style=social){ loading=lazy }](https://github.com/sponsors/ofek) |
 
 -----
 

diff --git a/hack/update-codegen.sh b/hack/update-codegen.sh
@@ -1,6 +1,5 @@
 #!/usr/bin/env ash
 
-# docker run --rm -v $PWD:/go/src/github.com/ofek/csi-gcs -w /go/src/github.com/ofek/csi-gcs golang:1.18.2-alpine3.15 ./hack/update-codegen.sh
 apk add --update --no-cache bash
 go get -u k8s.io/[email protected]
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -13,11 +13,23 @@ theme:
   name: material
   language: en
   features:
+    - navigation.sections
     - navigation.tabs
   palette:
-    scheme: slate
-    primary: blue
-    accent: blue
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
   font:
     text: Roboto
     code: Roboto Mono
@@ -51,7 +63,9 @@ markdown_extensions:
   # Built-in
   - markdown.extensions.abbr:
   - markdown.extensions.admonition:
+  - markdown.extensions.attr_list:
   - markdown.extensions.footnotes:
+  - markdown.extensions.meta:
   - markdown.extensions.tables:
   - markdown.extensions.toc:
       permalink: true
@@ -79,23 +93,23 @@ markdown_extensions:
   - pymdownx.magiclink:
       repo_url_shortener: true
       repo_url_shorthand: true
+      social_url_shortener: true
       social_url_shorthand: true
+      normalize_issue_symbols: true
       provider: github
       user: ofek
       repo: csi-gcs
   - pymdownx.mark:
+  - pymdownx.progressbar:
+  - pymdownx.saneheaders:
   - pymdownx.smartsymbols:
   - pymdownx.snippets:
-      base_path: docs/.snippets
+      check_paths: true
+      base_path:
+        - docs/.snippets
   - pymdownx.superfences:
-      custom_fences:
-        - name: mermaid
-          class: mermaid
-          format: !!python/name:pymdownx.superfences.fence_code_format
-        - name: math
-          class: arithmatex
-          format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
   - pymdownx.tabbed:
+      alternate_style: true
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.tilde:
@@ -114,5 +128,3 @@ extra:
       link: https://www.linkedin.com/in/ofeklev/
 extra_css:
   - assets/css/custom.css
-extra_javascript:
-  - assets/js/custom.js
diff --git a/tasks/__init__.py b/tasks/__init__.py
@@ -5,6 +5,7 @@
 from . import test
 from . import env
 from . import build
+from . import codegen
 from .utils import set_root
 
 ns = Collection()
@@ -13,5 +14,6 @@
 ns.add_collection(Collection.from_module(test))
 ns.add_collection(Collection.from_module(env))
 ns.add_collection(Collection.from_module(build))
+ns.add_collection(Collection.from_module(codegen))
 
 set_root()
diff --git a/tasks/codegen.py b/tasks/codegen.py
@@ -0,0 +1,19 @@
+from invoke import task
+
+from .utils import get_root
+
+
+@task(
+    default=True,
+)
+def codegen(ctx):
+    mount_dir = '/go/src/github.com/ofek/csi-gcs'
+    ctx.run(
+        f'docker run '
+        f'--rm '
+        f'-v "{get_root()}:{mount_dir}" '
+        f'-w {mount_dir} '
+        f'golang:1.18.2-alpine3.15 '
+        f'./hack/update-codegen.sh',
+        echo=True,
+    )
diff --git a/tox.ini b/tox.ini
@@ -9,17 +9,17 @@ skip_install = true
 
 [testenv:docs]
 deps =
-    mkdocs>=1.1.0
+    mkdocs~=1.3.0
     ; theme
-    mkdocs-material>=5.1.1
+    mkdocs-material~=8.2.8
     ; plugins
-    mkdocs-minify-plugin>=0.2.3
-    mkdocs-git-revision-date-localized-plugin>=0.4.6
+    mkdocs-minify-plugin~=0.5.0
+    mkdocs-git-revision-date-localized-plugin~=1.0.0
     ; Extensions
-    pymdown-extensions>=7.1
-    mkdocs-material-extensions>=1.0b2
-    mkpatcher>=1.0.2
+    pymdown-extensions~=9.3.0
+    mkdocs-material-extensions~=1.0.3
+    mkpatcher~=1.0.2
     ; Necessary for syntax highlighting in code blocks
-    Pygments>=2.5.2
+    Pygments~=2.11.2
 commands =
     python -m mkdocs {posargs}