docs: sync Sphinx site with develop and fix outdated content#36
Merged
KerwinTsaiii merged 2 commits intodocsfrom Mar 5, 2026
Merged
docs: sync Sphinx site with develop and fix outdated content#36KerwinTsaiii merged 2 commits intodocsfrom
KerwinTsaiii merged 2 commits intodocsfrom
Conversation
Sync documentation: - Rewrite JupyterHub config guide with full custom section docs (authMode, adminUser, accelerators, resources, teams, quota, gitClone) - Rewrite GitHub OAuth setup: OAuth App → GitHub App flow, add migration guide - Update authentication guide: security best practices for GitHub App, fix package name (nativeauthenticator → firstuseauthenticator) - Rewrite admin manual workflows: all paths and config references updated to current architecture (values.yaml, runtime/hub/core/) Fix outdated references: - Paths: runtime/jupyterhub → runtime/chart, runtime/hub/core - Image names: aup-jupyterhub-hub → auplc-hub, aup-cpu-notebook → auplc-default - OAuth: scope [read:user, read:org] → scope [] for GitHub App - Frontend: runtime/admin/frontend/admin-frontend → runtime/hub/frontend - Repo URL: aup-learning-cloud-dev → aup-learning-cloud - helm_upgrade.bash working directory corrected to repo root - Multi-node: values-multi-nodes.yaml is standalone, no overlay needed Content additions: - Offline / Portable Operation section in single-node guide - kubectl permission denied and helm troubleshooting in multi-node - PhySim course and GPU base environment in overview table - acceleratorOverrides comment example Cleanup: - Delete outdated raw admin manual (develop removed it) - Delete redundant contributing/index.md (toctree duplicate) - Fix image paths (../../ → ../) and code block highlights (csv → text) - Fix heading levels in quick-start - Update copyright year to 2025-2026
3 tasks
- Copy raw deploy/ markdown files (deploy/README, ansible, k8s, nfs, scripts) to docs/deploy/ for archival - Update multi-node.md with actual inventory format (k3s_cluster/ server/agent), GPU driver install, Helm/K9s install, GPU device plugin, node labeling table, NFS server setup details, cluster reset/add-node procedures, ansible-specific troubleshooting
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.
Summary
developbranch codebaseaup-*→auplc-*), file paths (runtime/jupyterhub/→runtime/chart/+runtime/hub/), authenticator classes, and Helm commandsvalues.yamlconfig andauplc-installerCLIvalues-multi-nodes.yaml(not overlay), correct deploy commandsdocs/user-manual/aup-remote-lab-user-manual-admin-new.mdFiles changed (18 files, +1149 / -763)
Sphinx source pages:
source/jupyterhub/README.md— Full rewrite withcustomsection docssource/jupyterhub/github-oauth-setup.md— OAuth App → GitHub App migrationsource/jupyterhub/authentication-guide.md— Updated packages, paths, config formatsource/jupyterhub/configuration-reference.md— Fixed OAuth scope for GitHub Appsource/jupyterhub/quota-system.md— Fixed image pathssource/jupyterhub/user-management.md— Fixed code block highlightssource/user-guide/admin-manual.md— Rewritten workflowssource/installation/multi-node.md— Standalone config, correct pathssource/installation/single-node.md— Fixed build command, added offline sectionsource/installation/quick-start.md— Fixed heading levelssource/introduction/overview.md— Added PhySim, GPU base envsource/contributing/contributing.md— Fixed repo URL, frontend pathssource/conf.py— Updated copyright yearRaw docs synced from develop:
docs/jupyterhub/README.md,How_to_Setup_GitHub_OAuth.md,authentication-guide.mdDeleted:
source/contributing/index.md(duplicate toctree)docs/user-manual/aup-remote-lab-user-manual-admin-new.md(removed on develop)Test plan