This repository was archived by the owner on Apr 29, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 19
This repository was archived by the owner on Apr 29, 2025. It is now read-only.
[FEATURE]: Extract main README contents to separate files #151
Copy link
Copy link
Open
Labels
kind/documentationImprovements or additions to documentationImprovements or additions to documentationkind/enhancementNew feature or requestNew feature or requestpriority/lowAn issue with the product that doesn't impact the user much or not at all (ie tech debt)An issue with the product that doesn't impact the user much or not at all (ie tech debt)
Description
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 main README
:
Lines 21 to 23 in 0f86d5c
The main objective is to showcase that a user can take a trained model, | |
use pipelines to package it with all the dependencies into a container image, | |
and deploy it at the near edge location(s) (represented by ACM-managed clusters) in a centralized way. |
Describe the use-case or expected workflow
graph TB
A[Main README]
B[DEVELOPMENT.md]
C[CONTRIBUTING.md]
D[GUIDE.md]
E[pipelines/README.md]
F[acm/README.md]
G[pipelines/GITEA.md]
A -->|What is this repo for/about?| A
A -->|How do I build more code on top of this repo?| B
A -->|How can I contribute to this repo?| C
A -->|How do I set-up and use the code in this repo?| D
D -->|How do I set-up and use the pipelines code?| E
D -->|How do I set-up and use the ACM code?| F
E -.->|What if I want to use on-prem Git?| G
Describe alternatives you've considered
Could just not do anything ¯\(ツ)/¯
Additional context
N/A
Metadata
Metadata
Assignees
Labels
kind/documentationImprovements or additions to documentationImprovements or additions to documentationkind/enhancementNew feature or requestNew feature or requestpriority/lowAn issue with the product that doesn't impact the user much or not at all (ie tech debt)An issue with the product that doesn't impact the user much or not at all (ie tech debt)
Type
Projects
Status
No status