Open piotrpdev opened 11 months ago
IMO, I don't think we need a pipelines GITEA unless there is a specific pipeline feature (Task, integration, ...) that is specific to Gitea. When/If the time comes should it just be a `pipelines/GITOPS.md, to cover pipeline integration into a GitOps workflow?
Details
Is your feature request related to a problem? Please describe.
The main README is very long, it might be better to extract some of the information to separate files. I think the main
README
should serve as an index/pointer to any information you want, and mainly focus on describing the PoC and maybe listing the requirements.Most of the information added in #140 involves instructions, I think it would be better to extract this to a separate file e.g.
INSTRUCTIONS.md
/USAGE.md
/SETUP.md
/GUIDE.md
/etc. I'd personally move everything in the "Proof of Concept Edge use case with ACM" section to a separate file(s), apart from this description which would be helpful to have in the mainREADME
:https://github.com/opendatahub-io/ai-edge/blob/0f86d5c8096d3889cada49d8e1b819fd35b327b2/README.md?plain=1#L21-L23
Describe the use-case or expected workflow
Describe alternatives you've considered
Could just not do anything ¯\(ツ)/¯
Additional context
N/A