Skip to content

docs(ocis-9.0): audit corrections, metadata enrichment, unique descriptions - #161

Open
dj4oC wants to merge 1 commit into
mainfrom
audit/ocis-9.0-docs-audit
Open

dj4oC wants to merge 1 commit into
mainfrom
audit/ocis-9.0-docs-audit

Conversation

@dj4oC

@dj4oC dj4oC commented Oct 26, 2026

Copy link
Copy Markdown

Summary

Audit of the oCIS 9.0.0-rc.1 documentation (content/ocis/9.0) against ground truth: the running ocis-9.0.0-rc.1 binary, the oCIS source at tag v9.0.0-rc.1, and the owncloud/ocis-charts Helm chart.

201 files changed, +845/−212.

Phase 2 — Correctness fixes (37 files)

  • Corrected wrong env vars: metrics debug token is <SERVICE>_DEBUG_TOKEN per service (no global OCIS_DEBUG_TOKEN / --debug-token flag in 9.0); OCIS_LOG_LEVEL instead of --log-level
  • Removed stale references: accounts service (proxy resolves accounts via the CS3 userprovider only), GLAuth (replaced by idm)
  • flow-docs/request-flow.adoc fully rewritten and verified against the 9.0 request flow
  • development/debugging.adoc modernised (current service names, reva/v2, nats, ocis-debug frontend)
  • stable-8.2 → stable-9.0 branch names; continuous deployment now documents three flavors
  • ADR-0005 note (direction implemented via the graph service); 11 typo fixes

Phase 3 — Page enrichment (16 pages)

Service and deployment pages (settings, auth-basic, auth-bearer, auth-app, nats, idm, eventhistory, webui-customisation, tls) gained :readingTime:, :level:, :lastUpdatedVersion: 9.0.0-rc.1, :lastUpdatedDate: 2026-10-25, an abstract with a reading-time line, and an == FAQ section.

Phase 4 — Unique meta descriptions (185 files)

All pages that lacked :description: (172 developer + 13 admin command pages) now have unique descriptions of ≤155 characters. The 51 new FAQ headings use AP title case per content/AGENTS.md.

Phase 5 — Diagrams and tables (2 files)

Architecture and service-registry Mermaid diagrams updated to the 9.0 service layout; deployment-model pro/cons tables.

Verification

  • 331/331 pages in content/ocis/9.0 have :description:; 296 unique values; 0 duplicates involving newly added descriptions
  • npx antora --stacktrace site.yml: 0 errors; the only 2 asciidoctor warnings are pre-existing (auth-app.adoc, lines unchanged by this PR)
  • Rendered HTML spot-checks confirm the reading-time line, FAQ sections, and new meta descriptions
  • Every corrected env var, port, flag, and service name was checked against the running 9.0.0-rc.1 binary and the source at tag v9.0.0-rc.1

Open questions for maintainers

  1. Supported-OS matrix in the deployment docs vs the 9.0 release engineering matrix
  2. display_version: '9.0 (dev)' in the example config — confirm against the released binary
  3. Helm chart appVersion still 8.2.0 for the 9.0 line (chart repo update needed)

Full audit report: 40 findings (0 blockers, 16 major, 19 minor, 6 info).

@dj4oC
dj4oC requested a review from a team as a code owner October 26, 2026 07:59
@CLAassistant

CLAassistant commented Oct 26, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

…ptions

Audit of the oCIS 9.0.0-rc.1 documentation against the running oCIS
9.0.0-rc.1 binary, the oCIS source at tag v9.0.0-rc.1, and the
owncloud/ocis-charts Helm chart. 201 files changed (+845/-212):

- Phase 2 (37 files): correctness fixes - wrong env vars (metrics
  debug token, OCIS_LOG_LEVEL), wrong ports, stale accounts-service
  and GLAuth references, fully rewritten request-flow diagram,
  modernised debugging guide, corrected metrics guide, typo fixes,
  stable-8.2 -> stable-9.0 branch names, continuous deployment
  three flavors, ADR-0005 note.
- Phase 3 (16 pages): reading time, level, lastUpdatedVersion/Date
  attributes, abstracts, and FAQ sections with AP title case headings.
- Phase 4 (185 files): unique meta descriptions (<=155 chars) for all
  pages that lacked them; AP title case for new FAQ headings.
- Phase 5 (2 files): architecture and registry Mermaid diagrams and
  deployment-model pro/cons tables.

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>

Signed-off-by: David Walter <david.walter@kiteworks.com>
@dj4oC
dj4oC force-pushed the audit/ocis-9.0-docs-audit branch from e2a4e06 to 789740b Compare October 26, 2026 08:22

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants