iaas: reference OSISM instead of copying docs#386
Merged
Conversation
jklare
force-pushed
the
docs/iaas-reference-osism
branch
2 times, most recently
from
July 21, 2026 12:53
14fef85 to
f2f7866
Compare
jklare
marked this pull request as draft
July 21, 2026 12:57
jklare
force-pushed
the
docs/iaas-reference-osism
branch
from
July 21, 2026 13:02
f2f7866 to
2e4efe4
Compare
The IaaS Layer of the docs is not maintained within the SCS community repositories: at build time getDocs.js cloned osism/osism.github.io and copied three trees verbatim into docs/02-iaas/ (the OpenStack tools, the whole guides tree, and the testbed). These were partial, drifting copies of osism.tech/docs that went stale and mixed with the few pages that are maintained in this repository. Stop mirroring OSISM and instead present it as the stack the SCS IaaS reference implementation was built with, linking out to the official OSISM documentation: - Remove the three osism/osism.github.io entries from docs.package.json so no OSISM content is copied on build. - Add an SCS-authored landing page (docs/02-iaas/index.md) that frames OSISM (OpenStack, Ceph, Kolla/kolla-ansible) as the reference implementation, notes that SCS is a modular software stack with more than one implementation nowadays, links to the top-level OSISM documentation categories, and surfaces the Image Manager and Flavor Manager tools OSISM provides for SCS standard compliance. - Point the IaaS Layer sidebar category at the new landing page and drop the Components sub-category (image/flavor manager were OSISM pulls). - Repoint every internal link that targeted the removed OSISM copies to osism.tech (index.mdx, faq, artcodix, preinstall-checklist) and update the architecture overview data so the IaaS tiles link to the OSISM tool pages. In identity-federation-in-scs, point the Keycloak reference to OSISM's Keycloak component docs instead of the testbed, since Keycloak is no longer deployed by the OSISM testbed. Guides and Deployment Examples now resolve to only the pages maintained in this repository (security groups, user data backups, artcodix). Verified with a production build: no IaaS-related broken links remain and all outbound OSISM/scs.community links resolve. DocImpact Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Jan Klare <[email protected]>
jklare
force-pushed
the
docs/iaas-reference-osism
branch
from
July 21, 2026 13:04
2e4efe4 to
003eb9e
Compare
The CI markdown-link-check validates every link in the files touched by the previous commit and reported three dead links, two of them pre-existing in files this branch already modified: - identity-federation-in-scs: the OpenStack Federation via OpenID-Connect link pointed at the old /dev-docs/ route, which now 404s; the section lives under /contributor-docs/. - preinstall-checklist: the "are contributing" self-link used a malformed github.com/.../docs/docs/... path (404); point it at the blob/main URL. - iaas landing page: https://ceph.io/ returns 500 to the checker; use https://www.ceph.io/en/, which resolves. Assisted-by: Claude:claude-opus-4-8 Signed-off-by: Jan Klare <[email protected]>
jklare
marked this pull request as ready for review
July 21, 2026 13:12
Contributor
Author
Closed
Contributor
|
Spare time, hahaha. Seriously though, it looks good at first glance. I've just triggered the deploy-to-staging workflow, and we shall be able to see the result under https://docs-staging.scs.community/ shortly! If that looks right, I'd say merge away! |
mbuechse
approved these changes
Jul 21, 2026
mbuechse
left a comment
mbuechse
left a comment
Contributor
There was a problem hiding this comment.
The deployed version on staging looks fine to me...
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
The IaaS Layer of the docs is not maintained within the SCS community
repositories: at build time
getDocs.jsclonedosism/osism.github.ioand copiedthree trees verbatim into
docs/02-iaas/(the OpenStack tools, the whole guidestree, and the testbed). These were partial, drifting copies of osism.tech/docs
that went stale and mixed with the few pages actually maintained here.
This PR stops mirroring OSISM and instead presents it as the stack the SCS IaaS
reference implementation was built with, linking out to the official OSISM
documentation.
Changes
docs.package.json— remove the threeosism/osism.github.ioentries so noOSISM content is copied on build.
docs/02-iaas/index.md(new) — an SCS-authored IaaS Layer landing page thatframes OSISM (OpenStack, Ceph, Kolla/kolla-ansible) as the reference
implementation, notes that SCS is a modular software
stack with more than
one implementation nowadays, and links to the top-level OSISM documentation
categories rather than individual guides.
sidebarsDocs.js— point the IaaS Layer category at the new landing page anddrop the Components sub-category (image/flavor manager were OSISM pulls).
copies to osism.tech (
index.mdx,08-faq,artcodix,preinstall-checklist,identity-federation-in-scs) and updatearchitecturalOverviewData.jsonso theIaaS tiles link to the OSISM tool pages.
Guides and Deployment Examples now resolve to only the pages maintained in this
repository (security groups, user data backups, artcodix).
Verification
node getDocs.jsno longer clones OSISM or creates thecomponents/ OSISMguides/testbedtrees.npm run buildsucceeds with no IaaS-related broken links; the pre-existingwarnings (cluster-stacks quickstart, scs-health-monitor, opendesk) are unrelated.
Note
Not included here, but worth a separate fix: the pre-commit hook is broken
independently of this change —
.lintstagedrc.jsoncallsmarkdownlint-cli2-fix,which the installed
markdownlint-cli2v0.22.1 (after the node v24 upgrade) nolonger ships as a separate binary. It is now
markdownlint-cli2 --fix.🤖 Generated with Claude Code