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

Repo documentation #189

Closed
8 tasks done
tjkirch opened this issue Aug 26, 2019 · 5 comments
Closed
8 tasks done

Repo documentation #189

tjkirch opened this issue Aug 26, 2019 · 5 comments
Labels
type/documentation Documentation update/creation

Comments

@tjkirch
Copy link
Contributor

tjkirch commented Aug 26, 2019

These are the basic docs we'd like before launch:

  • README.md - basic overview, link to more specific docs
  • INSTALL.md - image build process, and setup process to use Thar with EKS
  • workspaces/api/README.md - the API system - its components and how they work together
  • workspaces/api/migration/README.md - the migration system
  • workspaces/api/migration/migrator/README.md - the migrator (using cargo-readme)
  • workspaces/updater/README.md - the update system
  • packages/README.md - the packaging process
  • extras/dogswatch/README.md - update operator
@tjkirch
Copy link
Contributor Author

tjkirch commented Aug 28, 2019

API system: #200
migrator: #201
migration system: #202
INSTALL: #203

@tjkirch
Copy link
Contributor Author

tjkirch commented Aug 28, 2019

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.

@bcressey
Copy link
Contributor

I will write the README for packages & images.

@iliana iliana mentioned this issue Sep 19, 2019
@etungsten etungsten added the type/documentation Documentation update/creation label Sep 26, 2019
@sam-aws
Copy link
Contributor

sam-aws commented Oct 4, 2019

Currently writing up some things for updater/

@tjkirch
Copy link
Contributor Author

tjkirch commented Oct 16, 2019

Updater: #381

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/documentation Documentation update/creation
Projects
None yet
Development

No branches or pull requests

6 participants