Serve docs statically#283
Merged
runleveldev merged 8 commits intomainfrom Apr 24, 2026
Merged
Conversation
runleveldev
force-pushed
the
runleveldev-patch-1
branch
from
8051f6f to
3dd75f5
Compare
runleveldev
changed the title
runleveldev
force-pushed
the
runleveldev-patch-1
branch
2 times, most recently
from
f1412d2 to
37d23d4
Compare
…s service Replace the proxy_pass to localhost:2998 in the bare-domain nginx server block with a root + try_files directive serving static files from the Docusaurus build directory. - nginx-conf.ejs: static file serving from /opt/opensource-server/mie-opensource-landing/build - Makefile: remove systemd service install/enable/start from install-docs - Delete mie-opensource-landing/systemd/opensource-docs.service - Dockerfile: install nginx, serve on port 80, add standalone site config - New images/docs/docs-site.conf for the test container Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
runleveldev
force-pushed
the
runleveldev-patch-1
branch
5 times, most recently
from
14c16f0 to
84514b9
Compare
- Replace Docusaurus 3 (React/Node.js) with Zensical + Material for MkDocs - Convert 8 MDX files to Markdown, replace React components with native syntax - Convert all admonitions from :::type to fg! type format - Create landing page with Material grid cards - Add navigation tabs, edit button, search, dark mode, Mermaid diagrams - Fix 38+ internal links, move images to docs/assets/img/ - Remove all Docusaurus files (node_modules, src/, package.json, etc.) - Update .gitignore and README.md for Zensical workflow Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
runleveldev
force-pushed
the
runleveldev-patch-1
branch
from
84514b9 to
50e0b20
Compare
runleveldev
force-pushed
the
runleveldev-patch-1
branch
from
9dec15e to
06efce5
Compare
runleveldev
force-pushed
the
runleveldev-patch-1
branch
from
06efce5 to
61539b4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rationale
The existing
npm run serveservice takes an additional port (2998) and introduces an extra hop to just serve static files. This PR allows NGINX to serve the files directly (which it excels at) avoiding port-in-use conflicts and simplifying operations. It also converts the site generation to Zensical to avoid Docusaurus's bloated and vulnerable dependencies, add dark mode, and support doc search.Migration
uvhttps://docs.astral.sh/uv/getting-started/installation/cd mie-opensource-landing && uv run zensical buildsystemctl disable --now opensource-docs.servicerm /etc/systemd/system/opensource-docs.servicesystemctl daemon-reloadUpdating documentation after this patch
Instead of running
systemctl restart opensource-docs.servicejust runcd mie-opensource-landing && uv run zensical buildScreenshots
Light Mode
Dark Mode
Search
Copilot Summary
This pull request makes significant improvements to the documentation site for MIE's open source Proxmox cluster. The main changes involve switching the docs site to use static serving with NGINX instead of a Node.js service, updating deployment and build processes, and modernizing documentation links and formatting for consistency and clarity.
Deployment and Serving Changes:
docs-site.conf), updating the Dockerfile to install NGINX, exposing port 80, and removing Node.js service references from the Makefile and deployment scripts. [1] [2] [3] [4]Documentation and Build Process Updates:
site/directory, and the.gitignoreandREADME.mdhave been updated to reflect the new Python/MkDocs-based workflow. The.env.examplefile was removed, and a.python-versionfile was added for Python 3.13 compatibility. [1] [2] [3] [4]Documentation Content and Formatting Improvements:
All internal documentation links have been updated to use relative
.mdreferences for compatibility with MkDocs, and Docusaurus-specific sidebar metadata and category files have been removed. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21]Docusaurus-specific admonitions (
:::tip,:::important) have been replaced with MkDocs/Material-style admonitions (!!! tip,!!! warning). [1] [2] [3] [4] [5] [6]API Documentation:
operationIdto thelistSitesendpoint in the OpenAPI spec for improved API documentation and code generation.