@@ -8,19 +8,26 @@ Multi-staging Deployment Manager (DM). MD consists of the client and server part
882. [ ] Case study(Technical perspective). We consider different of approaches mentioned in 1. We cover isolation, reliability, time management.
993. [ ] Technical architecture. Description of all components. Diagrams. We should talk about the choice of running of top Kubernetes and Helm, asynchronous architecture, status updates.
10104. [ ] User guide. Mentions all the major actions user can do, talks about container/app level overrides, logging.
11−5. [ ] Deployment guide for Helm-based projects. Includes a description of all the necessary steps to deploy the DM in such an environment, `examples/helm` with code
12−6. [ ] Deployment guide for Helmless projects. Includes a description of all the necessary steps to deploy the DM in such an environment, `examples/k8s` with code
13−7. [ ] Motivating example dealing with cloud APIs, secret storages projects. Includes a motivation and examples of writing a wrapper passing the secrets to the app managed by DM, `examples/secrets` with code
11+5. [ ] Deployment guide for Helm-based projects. Includes a description of all the necessary steps to deploy the DM in such an environment, `examples/helm` with code.
12+6. [ ] Deployment guide for Helmless projects. Includes a description of all the necessary steps to deploy the DM in such an environment, `examples/k8s` with code.
13+7. [ ] Motivating example dealing with cloud APIs, secret storages projects. Includes a motivation and examples of writing a wrapper passing the secrets to the app managed by DM, `examples/secrets` with code.
14148. [ ] Announcement blog post containing key points from 1 and 2, linking the documentation 3-6.
15159. [ ] Video showcasing the common use-case: create a new staging, it ends up in the `running` status, we show the resources on the View Staging page, click on them and go visit the app. Then we edit it, let it update(we skip it in the video), go to the app again and showcase the change somehow.
161610. [ ] Slideshow presentation accompanying the DM demo.
17+11. [ ] Better project title.
18+12. [ ] Project Icon. Depends on 11.
19+13. [ ] README.md mentioning all the documents mentioned above and cross-linking all documentation chapters.
20+14. [ ] Proper documentation in the code. Haddocks.
1721
22+# Nix Installation
1823
1924```bash
2025curl https://nixos.org/nix/install | sh
2126```
2227
23−2. Build the project
28+# Development
29+
30+Build the project
2431
2532```bash
2633make build