Skip to content
This repository has been archived by the owner on Mar 29, 2024. It is now read-only.

docs consolidation #33

Open
4 tasks
casperdcl opened this issue Jul 14, 2023 · 3 comments
Open
4 tasks

docs consolidation #33

casperdcl opened this issue Jul 14, 2023 · 3 comments

Comments

@casperdcl
Copy link
Contributor

casperdcl commented Jul 14, 2023

Single Source of Truth which all repo READMEs can link to

@filopedraz
Copy link
Contributor

Should we move the info in the prem-app/README to the dev portal? Following the single source of truth architecture?

@casperdcl casperdcl moved this from Todo to In Progress in Prem ML Jul 27, 2023
@tiero
Copy link
Contributor

tiero commented Jul 28, 2023

@filopedraz I do think the README should contain the information for contributors and who want to work on the code (how to build, test, release etc..)

I would keep video and get started for the sake of it, then all the rest in dev portal yes

@filopedraz
Copy link
Contributor

filopedraz commented Jul 28, 2023

@tiero can you list here which sections you would keep in prem-app/README.md

  • Getting Started?
  • Usage?
  • Demo?
  • Contributing?

I am not convinced about Getting Started because soon it will have many more information (k8s, docker swarm etc).

@casperdcl casperdcl moved this from In Progress to Todo in Prem ML Aug 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
No open projects
Status: Todo
Development

No branches or pull requests

3 participants