-
Notifications
You must be signed in to change notification settings - Fork 522
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
Repo documentation #189
Comments
I'm hoping @iliana can write or delegate the updater README. I'm hoping @bcressey can write or delegate the packaging README - perhaps after the changes he's working on are settled, since they'll affect the process. I'm hoping @jahkeup can write or delegate the README for the update operator. I'm working on the root-level README. |
I will write the README for packages & images. |
Currently writing up some things for |
Updater: #381 |
These are the basic docs we'd like before launch:
README.md
- basic overview, link to more specific docsINSTALL.md
- image build process, and setup process to use Thar with EKSworkspaces/api/README.md
- the API system - its components and how they work togetherworkspaces/api/migration/README.md
- the migration systemworkspaces/api/migration/migrator/README.md
- the migrator (using cargo-readme)workspaces/updater/README.md
- the update systempackages/README.md
- the packaging processextras/dogswatch/README.md
- update operatorThe text was updated successfully, but these errors were encountered: