Task: Open Source Development Documentation

[reshnm]

Understand the Task

Currently the open source docs is just a collection of markdown files.
We should have a documentation technology that creates a github page and gives an easer to use user experience.

https://github.com/openmcp-project/docs (openmcp driven)

• openmcp PlatformOwner (how do i set this up)
• openmcp Contributor/developer - how do i work on this, how will it evolve technically? adrs? arch?

Steps needed to complete this task:

1. Create DNS record for docs.openmcp.cloud
2. Configure GitHub Pages to use custom domain
3. Move code from internal documentation to public repository

Any further valuable resources.

No response

What is required to accept the Task as done.

Done Criteria

• Documentation is publicly-available at https://docs.openmcp.cloud

[ValentinGerlach]

We decided to use Hugo for the public documentation.

[In-Ko]

Is the last comment still valid ? I heard slightly contradicting things in the meantime.

[In-Ko]

Talked to Valentin again, seems the Hugo decision is still valid, and supported by most team members.

[ValentinGerlach]

We have revisited the decision regarding the tool to use and switched to Docusaurus. The documentation lives in https://github.com/openmcp-project/docs but the visibility still needs to be set to public.

[maximiliantech]

The repository is complaint with OSPO and now publicly available, see https://github.com/openmcp-project/docs. Open Sourcing is finished. We can close the ticket.