opendatahub-io-contrib / datamesh-platform

Apache License 2.0
5 stars 5 forks source link

Define high level structure for datamesh-platform documentation #45

Open avinashsingh77 opened 1 month ago

avinashsingh77 commented 1 month ago

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:

caldeirav commented 1 month ago

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: