To help a user who is directly browsing the repository obtain some inherent value a series of reports will be generated from the metadata stored in the repository. This will enable a developer, product manager, or any other actor to see what's stored in the repository. Since this is a part of the open-source package detailed reporting and charting will not be worked on at this time.
Implementation Notes
Reports should start at the main README.md file at the root of the repository and point down to the Companies/README.md file. Additionally, this main report should include references to the open source package, warnings about not modifying the content in the reports, and some intelligence on this and other other Action that is running.
Individual company reports will include the company's name without any spaces or punctuation.
There should be full forwards and backwards linking from the main README to an individual company file and back the other direction.
A map using geoJson should be built to show where the company sits geographically.
Key metadata like description, industry, interactions, etc. should be in the company report, but if there isn't something present (example no interactions) then that section should be absent from the report.
The reporting action should run every night at midnight
If a company is deleted from the repository then the report should remove the markdown file for that company
Introduction
To help a user who is directly browsing the repository obtain some inherent value a series of reports will be generated from the metadata stored in the repository. This will enable a developer, product manager, or any other actor to see what's stored in the repository. Since this is a part of the open-source package detailed reporting and charting will not be worked on at this time.
Implementation Notes
README.md
file at the root of the repository and point down to theCompanies/README.md
file. Additionally, this main report should include references to the open source package, warnings about not modifying the content in the reports, and some intelligence on this and other other Action that is running.geoJson
should be built to show where the company sits geographically.