MPAS documentation

[robertwol]

Create comprehensive MPAS system documentation for the end user.

Description Existing project documentation is to be revised for correctness. Some links content missing. Should we convert existing concept papers to end-user technical documentation? or keep this as an architecture concept document and create a new one?

Stories:

• Related: open-component-model/ocm-website#137
• MPAS Documentation Website: open-component-model/ocm-project#49

To Be done (Link related PRs/issues)

• Make the documentation less complicated!
• Make the page public

Not part of this epic: ~https://github.com/open-component-model/ocm-project/issues/87~

[shivenduverma-sap]

Optional topics:

• Mentioning which resources are created in the mpas-system namespace and which are created in the project namespace
• Mentioning which support resources that are required in the project namespace in the form of secrets: component-version signing verification secret and name, git credentials, registry credentials, etc.
• Maybe document with diagram what needs to be accessible in the ocm-sytem, mpas-system, project namespace in source cluster and what needs to be available in the target namespace in the target cluster. Eg:
  • Git can be local/hosted for the source cluster with git credentials in mpas-system, project namespace
  • oci registry for pulling component version can be local/hosted with credentials in ocm-system, mpas-system
  • registry for pulling images for deployment needs to be accessible to target namespace in the target cluster via service-account in targets

[robertwol]

We need better documentation of the CRDs, and how to setup project, target, etc with them

[souleb]

https://github.com/open-component-model/ocm-website/pull/163

[github-actions[bot]]

This issue was marked as stale because it has not had recent activity.