Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define high level structure for datamesh-platform documentation #45

Open
avinashsingh77 opened this issue Jul 19, 2024 · 1 comment
Open
Assignees

Comments

@avinashsingh77
Copy link
Collaborator

This issue aims and identifying how the documentation for this repository should be so that it is easy to follow along for the contributors.
The readme should be structured, detailed and at the same time easy to follow for installation and usage of the platform.
It could have sections like:

  • How the platform works
  • How to install the platform
  • How to build a data pipeline
  • others..
@caldeirav
Copy link
Collaborator

Indeed, thanks for starting this, and I think we should be looking at best examples of content management in other Github repos and typically this means going back to a template (e.g. https://github.com/othneildrew/Best-README-Template) to structure our content and include:

  • A shorter overview of the platform (we can move detailed content to an architecture documentation page)
  • Dependencies and Install instructions (starting with OpenShift deployment)
  • Quickstart (I can take care of this, it will be based on the data-product-template repo but it makes sense to have the instructions here)
  • Roadmap (link to the project page)
  • How to contribute

@jpaulrajredhat jpaulrajredhat self-assigned this Jul 20, 2024
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

No branches or pull requests

3 participants