Restructure docs in deployment order and migrate to OKF v0.2 - #5
Merged
Merged
Conversation
Convert the documentation bundle to the Open Knowledge Format v0.2 and reorganize it to follow the order in which CyVerse is actually deployed. Format (OKF v0.2) - Every concept document carries YAML frontmatter: type, title, description, tags, status, generated, and sources where the content is derived from something. - Every directory carries an index.md listing, with the bundle-root index declaring okf_version. - Bundle history is recorded in docs/log.md. - references/ holds provenance notes for derived material. Structure - architecture/ what the system is, what it needs, what depends on what - platform/ the products and services offered to users - deployment/ phases 1-7, ordered by dependency - operations/ running a deployed system - api/, development/, references/ - deployments/, database/, guides/, and services/ are retired; their content moved into the tree above. New content - deployment/from-scratch.md: end-to-end runbook for a two-node deployment, written from an anonymized pilot deployment record. All hostnames, zone names, DNs, realm and client names, and credentials are placeholders; secrets are generated per install. - Previously undocumented steps: HAProxy, iRODS provider and DE integration, iCAT, database migrations, cert-manager, Harbor, Argo, OpenLDAP, OpenSearch, NATS, bootstrap, verification, troubleshooting. - architecture/component-inventory.md and network-requirements.md. Editorial - Deduplicated: mail (exim4 + local-exim), the golang-migrate procedure repeated in every database document, the deployment-order list that appeared in three places, the database list that appeared twice, and two retired overview pages now covered by directory indexes. - Corrected: databases ordered before the services that need them; the rsyslog path; dirname vs basename for the kubeconfig directory; the helm uninstall invocation; VRRP as IP protocol 112 rather than a TCP port; QMS extensions created in the qms database; recomputed sizing totals with the source's 100/110 TB discrepancy noted. - Fixed the docs build: zensical.toml named a theme that is not installable, so the published build was failing, and extra_css named a stylesheet that does not exist. - Marked Elasticsearch deprecated in favor of OpenSearch, and ingress-nginx transitional in favor of Traefik. - Replaced site-specific hostnames, DNs, and sample credentials with placeholders; replaced XXX placeholders in the system overview. - Fixed 13 broken anchors and links; the build now reports no issues. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UKieNHmYbysTvGDK2SC1YM
tyson-swetnam
marked this pull request as ready for review
July 30, 2026 12:12
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
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.
Convert the documentation bundle to the Open Knowledge Format v0.2 and
reorganize it to follow the order in which CyVerse is actually deployed.
Format (OKF v0.2)
description, tags, status, generated, and sources where the content is
derived from something.
index declaring okf_version.
Structure
content moved into the tree above.
New content
deployment, written from an anonymized pilot deployment record. All
hostnames, zone names, DNs, realm and client names, and credentials
are placeholders; secrets are generated per install.
integration, iCAT, database migrations, cert-manager, Harbor, Argo,
OpenLDAP, OpenSearch, NATS, bootstrap, verification, troubleshooting.
Editorial
repeated in every database document, the deployment-order list that
appeared in three places, the database list that appeared twice, and
two retired overview pages now covered by directory indexes.
rsyslog path; dirname vs basename for the kubeconfig directory; the
helm uninstall invocation; VRRP as IP protocol 112 rather than a TCP
port; QMS extensions created in the qms database; recomputed sizing
totals with the source's 100/110 TB discrepancy noted.
installable, so the published build was failing, and extra_css named a
stylesheet that does not exist.
ingress-nginx transitional in favor of Traefik.
placeholders; replaced XXX placeholders in the system overview.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01UKieNHmYbysTvGDK2SC1YM