Zensical

.github/workflows/gh-actions.yml

@@ -1,27 +1,25 @@
-name: mkdocs
-
+name: Publish docs via GitHub
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
 
 jobs:
   build:
+    name: Deploy docs
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [ 3.8 ]
-
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
-          architecture: x64
-
-      - name: Install requirements
-        run: python3 -m pip install -r requirements.txt
-
-      - name: Deploy 🚀
-        run: python3 -m mkdocs gh-deploy --force
+          python-version: 3.11
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Build documentation
+        run: zensical build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          force_orphan: true

.gitignore

@@ -0,0 +1,133 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Claude Code
+CLAUDE.md
+.claude/

LICENSE

@@ -0,0 +1,22 @@
+# License for CyVerse Documentation
+
+Documentation contained in this repo is made available under at CC BY 4.0 License: 
+https://creativecommons.org/licenses/by/4.0/legalcode 
+
+You may:
+
+- Share—copy and redistribute the material in any medium or format
+- Adapt—remix, transform, and build upon the material
+
+for any purpose, even commercially. The licensor cannot revoke these freedoms as long as you follow these license terms:
+
+**Attribution—** You must give appropriate credit (mentioning that your work is derived from work that is Copyright (c) CyVerse and, where practical, linking to http://www.cyverse.org/), provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+
+No additional restrictions—You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. With the understanding that:
+
+- You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
+- No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
+
+This license is superseded by and subject to any and all other polices of CyVerse as described at: http://www.cyverse.org/policies; CyVerse is based upon work supported by the National Science Foundation under Grant No. DBI-0735191 and DBI-1265383.
+
+Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.

README.md

@@ -0,0 +1,47 @@
+A special thanks to [Mojib Wali](https://github.com/mb-wali) of [CyVerse-Austria](https://www.tugraz.at/sites/cyverse/home), Graz University of Technology, Austria, for creating the initial Material MkDocs pages for the global CyVerse developer and maintainer community!
+
+CyVerse Core Software Documentation
+===================================
+
+These documents are for the deployment and maintenance of [CyVerse](https://cyverse.org)
+
+## Zensical Static Site Generator
+
+This documentation is built using [Zensical](https://zensical.com), a modern static site generator from the team behind Material for MkDocs. The site uses Zensical's "classic" theme which provides the familiar Material for MkDocs appearance with enhanced features.
+
+## GitHub Actions Deployment
+
+The `main` branch uses GitHub Actions to automatically build and deploy the documentation.
+
+Do not commit changes directly to the `main` branch unless necessary. Please commit your updates to the `mkdocs` branch, test on CodeSpaces or locally, and then commit those merges back to `main`.
+
+Commits to `main` will trigger the Action which re-builds and deploys the website to https://docs.cyverse.org -- which is publicly available.
+
+## Configuration
+
+The documentation is configured using `zensical.toml` (TOML format) instead of the traditional `mkdocs.yml`. This provides better configuration management and access to Zensical-specific features.
+
+## Local Development
+
+```bash
+git clone https://github.com/cyverse/docs
+cd docs
+pip install -r requirements.txt
+zensical serve
+```
+
+After starting the development server, the site will open at `http://localhost:8000`
+
+Open in browser and view
+
+Recommended: two monitors for easier display while working on docs.
+
+## Building
+
+To build the static site:
+
+```bash
+zensical build
+```
+
+Output will be in the `./site` directory. 

docs/CNAME

@@ -0,0 +1 @@
+docs.cyverse.org