Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE]: Extract main README contents to separate files #151

Open
piotrpdev opened this issue Oct 14, 2023 · 1 comment
Open

[FEATURE]: Extract main README contents to separate files #151

piotrpdev opened this issue Oct 14, 2023 · 1 comment
Labels
kind/documentation Improvements or additions to documentation kind/enhancement New feature or request priority/low An issue with the product that doesn't impact the user much or not at all (ie tech debt)

Comments

@piotrpdev
Copy link
Member

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:

ai-edge/README.md

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
Loading

Describe alternatives you've considered

Could just not do anything ¯\(ツ)

Additional context

N/A

@piotrpdev piotrpdev added kind/documentation Improvements or additions to documentation kind/enhancement New feature or request priority/low An issue with the product that doesn't impact the user much or not at all (ie tech debt) labels Oct 14, 2023
@LaVLaS
Copy link
Contributor

LaVLaS commented Oct 26, 2023

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Improvements or additions to documentation kind/enhancement New feature or request priority/low An issue with the product that doesn't impact the user much or not at all (ie tech debt)
Projects
Status: No status
Development

No branches or pull requests

2 participants