[#55] Add a general documentation #83
Conversation
malparty
force-pushed
the
feature/55-add-documentation
branch
3 times, most recently
from
bca2f3b to
3dd03de
Compare
malparty
force-pushed
the
feature/55-add-documentation
branch
4 times, most recently
from
87d9d61 to
463bc58
Compare
malparty
requested review from
hoangmirs,
andyduong1920,
byhbt,
hanam1ni,
junan,
longnd,
rosle,
Nihisil,
bterone and
Lahphim
as code owners
README.md
Outdated
| ```bash | ||
| npx @nimblehq/infra-template generate {project-name} | ||
| ``` | ||
|
|
||
| ## Deploy your infrastructure |
There was a problem hiding this comment.
As discussed, should we move this part Deploy your infrastructure to the generated project's readme
There was a problem hiding this comment.
We can create a Documentation add-on and will copy this content into the needed folder, maybe the wiki or README of the generated project 🤔
There was a problem hiding this comment.
IMO we do not need a "documentation add-on", it should be placed in the common files when a projected variant is created (this documentation is specific to the AWS variant).
Here is my suggested implementation: 17ed2a4 ✅
cc @hoangmirs
malparty
force-pushed
the
feature/55-add-documentation
branch
2 times, most recently
from
001ce12 to
19f1c21
Compare
malparty
force-pushed
the
feature/55-add-documentation
branch
from
19f1c21 to
17ed2a4
Compare
Did you miss this comment? @malparty |
|
@hoangmirs thanks for the reminder! :-) |
What happened 👀
Insight 📝
The main idea was for me to reduce the need to ask questions on slack when using this template for the first time! :) This way we can save time/effort for everyone. ;-)
The diagram is modified and stored in the Infrastructure-template folder in our Lucid account!
Proof Of Work 📹
Main Template README.md
README.md of the generated project: