Skip to content

Feat/add osism concepts#380

Open
garloff wants to merge 6 commits into
mainfrom
feat/add-osism-concepts
Open

Feat/add osism concepts#380
garloff wants to merge 6 commits into
mainfrom
feat/add-osism-concepts

Conversation

@garloff

@garloff garloff commented Jul 5, 2026

Copy link
Copy Markdown
Member

This was lacking from SCS docu, leaving out important pieces of the OSISM documentation.

garloff added 4 commits July 5, 2026 18:23
Signed-off-by: Kurt Garloff <kurt@garloff.de>
Signed-off-by: Kurt Garloff <kurt@garloff.de>
Signed-off-by: Kurt Garloff <kurt@garloff.de>
Signed-off-by: Kurt Garloff <kurt@garloff.de>
@garloff garloff requested review from berendt, jklare and maxwolfs July 5, 2026 18:38
@garloff garloff self-assigned this Jul 5, 2026
@garloff garloff added documentation Improvements or additions to documentation enhancement New feature or request IaaS Issues or pull requests relevant for Team1: IaaS labels Jul 5, 2026
@garloff

garloff commented Jul 6, 2026

Copy link
Copy Markdown
Member Author

You can review the effects of this on https://docs-staging.scs.community/ ...

@jklare

jklare commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Mh, I am a bit confused why half of the OSISM documentation should be (and already is) mirrored to the scs community docs page. Wouldn't it make more sense to write a short intro about what OSISM is and then just link to the OSISM docs page? This way, it would be a lot easier to ensure that the content is complete, up to date and in the right context.

@garloff

garloff commented Jul 7, 2026

Copy link
Copy Markdown
Member Author

We do import most of the OSISM docs as the documentation for the SCS IaaS Reference implementation.
This is obviously a relic of the times when there was precisely one. So we have to evolve this conceptually:

  • Allow for additional options and import the docs in here as well (if there is suitable material)
  • Replace the whole thing by links

Until we have done restructuring, I would at least keep things up-to-date, which is what this patch was meant to do.

Apart from this, you are of course correct that we need to go through our docs and sort the production-ready things from the PoC things and the current docs from outdated docs (from unknown currency).

@mbuechse

mbuechse commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

I'm with Jan on this. Let's merge this by all means, but at the same time let's just link to the official docs (definitely don't wait for a grand overhaul of the whole thing).

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

Labels

documentation Improvements or additions to documentation enhancement New feature or request IaaS Issues or pull requests relevant for Team1: IaaS

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

3 participants