Adjust to renaming doc/ to docs/

.github/workflows/publish.yml

@@ -7,13 +7,13 @@ name: Publish
 on:
   pull_request:
     paths-ignore:
-      - "doc/**"
+      - "docs/**"
       - "**.md"
       - ".github/workflows/*"
       - "!.github/workflows/publish.yaml"
   push:
     paths-ignore:
-      - "doc/**"
+      - "docs/**"
       - "**.md"
       - ".github/workflows/*"
       - "!.github/workflows/publish.yaml"

.github/workflows/test-chart.yaml

@@ -9,13 +9,13 @@ name: Test chart
 on:
   pull_request:
     paths-ignore:
-      - "doc/**"
+      - "docs/**"
       - "**.md"
       - ".github/workflows/*"
       - "!.github/workflows/test-chart.yaml"
   push:
     paths-ignore:
-      - "doc/**"
+      - "docs/**"
       - "**.md"
       - ".github/workflows/*"
       - "!.github/workflows/test-chart.yaml"

.github/workflows/test-docs.yaml

@@ -8,12 +8,12 @@ name: Test docs
 on:
   pull_request:
     paths:
-      - "doc/**"
+      - "docs/**"
       - "**/schema.yaml"
       - "**/test-docs.yaml"
   push:
     paths:
-      - "doc/**"
+      - "docs/**"
       - "**/schema.yaml"
       - "**/test-docs.yaml"
     branches-ignore:
@@ -27,17 +27,17 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
-          # chartpress, used by doc/conf.py, requires git history to set
+          # chartpress, used by docs/conf.py, requires git history to set
           # chart version and image tags correctly
           fetch-depth: 0
       - uses: actions/setup-python@v2
         with:
           python-version: "3.8"
 
       - name: Install deps
-        run: pip install -r doc/requirements.txt
+        run: pip install -r docs/requirements.txt
 
       - name: make linkcheck
         run: |
-          cd doc
+          cd docs
           make linkcheck SPHINXOPTS='--color -W --keep-going'

.readthedocs.yml

@@ -7,7 +7,7 @@ version: 2
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: doc/source/conf.py
+  configuration: docs/source/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: []
@@ -22,4 +22,4 @@ python:
     #          accepting the existing version.
     #
     #          ref: https://github.com/readthedocs/readthedocs.org/blob/0e3df509e7810e46603be47d268273c596e68455/readthedocs/doc_builder/python_environments.py#L335-L344
-    - requirements: doc/requirements.txt
+    - requirements: docs/requirements.txt

CONTRIBUTING.md

@@ -16,7 +16,7 @@ git clone https://github.com/jupyterhub/zero-to-jupyterhub-k8s
 
 # Setting up for documentation development
 
-See [doc/README.md](doc/README.md).
+See [docs/README.md](docs/README.md).
 
 # Setting up for Helm chart development
 
@@ -30,7 +30,7 @@ This needs to be installed:
 - Python 3.6+ (install at [Anaconda.com](https://www.anaconda.com/distribution/) or [Python.org](https://www.python.org/downloads/)) and dependencies:
   ```shell
   pip install -r dev-requirements.txt
-  pip install -r doc/requirements.txt
+  pip install -r docs/requirements.txt
   ```
 
 You can check if you have it all like this:

README.md

@@ -50,7 +50,7 @@ Much of the initial groundwork for this documentation is information learned
 from the successful use of JupyterHub and Kubernetes at UC Berkeley in their
 [Data 8](http://data8.org/) program.
 
-![](doc/source/_static/images/data8_massive_audience.jpg)
+![](docs/source/_static/images/data8_massive_audience.jpg)
 
 ## Acknowledgements
 

docs/README.md

@@ -8,7 +8,7 @@ in the `readthedocs.yml` file, and made available on
 ## Local documentation development
 
 ```shell
-cd doc
+cd docs
 pip install -r requirements.txt
 ```
 

docs/source/conf.py

@@ -254,7 +254,7 @@ def parse_schema(d, md=[], depth=0, pre=""):
     "github_user": "jupyterhub",
     "github_repo": "zero-to-jupyterhub-k8s",
     "github_version": "main",
-    "doc_path": "doc/source",
+    "doc_path": "docs/source",
 }
 
 html_favicon = "_static/images/logo/favicon.ico"

jupyterhub/README.md

@@ -15,4 +15,4 @@ The JupyterHub Helm chart is accompanied with an installation guide at [z2jh.jup
 
 Much of the initial groundwork for this documentation is information learned from the successful use of JupyterHub and Kubernetes at UC Berkeley in their [Data 8](http://data8.org/) program.
 
-![](https://raw.githubusercontent.com/jupyterhub/zero-to-jupyterhub-k8s/HEAD/doc/source/_static/images/data8_massive_audience.jpg)
+![](https://raw.githubusercontent.com/jupyterhub/zero-to-jupyterhub-k8s/HEAD/docs/source/_static/images/data8_massive_audience.jpg)

jupyterhub/schema.yaml

@@ -4,7 +4,7 @@
 #
 # This schema is also used by our documentation system to build the
 # configuration reference section based on the description fields. See
-# doc/source/conf.py for that logic!
+# docs/source/conf.py for that logic!
 #
 # We look to document everything we have default values for in values.yaml, but
 # we don't look to enforce the perfect validation logic within this file.