odpi / egeria-docs

Documentation repository for the Egeria project.
https://egeria-project.org
Other
23 stars 30 forks source link

Add documentation on GitHub repositories #42

Open planetf1 opened 3 years ago

planetf1 commented 3 years ago

It would be useful to capture key information about the GitHub repositories we use for Egeria. This is primarily for developers. The information could contain

An alternative option is to keep the link in the docs light, with only a repo name/link, and then point to a well defined .md file within each repository. This should be of a mandated format, but is then owned by the linked project. we loose searchability, and it is dependent on each repo making the change. It also may make it tricker to identify inconsistencies

We could model this in egeria.....

planetf1 commented 1 year ago

I opened #646 to improve the simple text table listing repos. This covers the first few items above & could be simply extended (ie existing metadata on the repo). Other content could be built from files in a standard format if required