add gitops-ee bootstrap cli user documentation#4073
Conversation
enekofb
left a comment
enekofb
left a comment
There was a problem hiding this comment.
Thanks waleed for taking the time to get the conversation started. some suggestions added.
| import TierLabel from "../../_components/TierLabel"; | ||
|
|
||
| # Install Weave GitOps Enterprise via CLI | ||
|
|
There was a problem hiding this comment.
Given we want to manage user expectations coming to the page they better decide whether they could
take advantage of the CLI vs other installation mechanisms, we should frame the persona and scenario that currently the cli is designed and the value it gets. Alternatively, to point the user to the default install method.
There was a problem hiding this comment.
| toc_max_heading_level: 4 | ||
| --- | ||
|
|
||
| import TierLabel from "../../_components/TierLabel"; |
There was a problem hiding this comment.
we could add some notes about maturity alpha and security considerations: do we consider mature and secure enough for running it against your production environment?
There was a problem hiding this comment.
do some assessment in terms of security risks
|
|
||
| The bootstrap wizard will take you step-by-step into configuring Weave GitOps Enterprise. To understand more about the CLI configurations experience, check the below sections [here](#cli-configurations). | ||
|
|
||
| ## Understanding `gitops-ee bootstrap` |
There was a problem hiding this comment.
what are the expectations for a platform engineer around this section?
|
|
||
| ## Appendix | ||
|
|
||
| ### CLI configurations |
There was a problem hiding this comment.
how do we expect to maintain/update the documentation, if there is an overhead or manual, it might get quickly outdated
enekofb
left a comment
enekofb
left a comment
There was a problem hiding this comment.
suggestions in the pr:
- reflect modes: interactive and non-interactive
- expand on the ssh access in particular the keys. they could go to the wizard
- cluster user instead of admin credentials to be consistent with existing documentation https://docs.gitops.weave.works/docs/enterprise/getting-started/install-enterprise/#securing-access-to-the-dashboard
- review the stages are up to date
- review the wording on the domain stage
- review external DNS, should not be part of bootstrapping. we dont manage dns.
- add some picture or screenshot so it is not so much text
- to sync: what is the goal of the steps section and whether is the best alternative, for example, if the cli is sefl-contained, why not just leverage to that instead of having it there in other ones
- cli configuration how would be maintained?
Added suggestions here #4115
* reviewed heading and pre-requirements * added initial review * refactoring dashboard access * ready for a second review * added externalDNS link
enekofb
left a comment
enekofb
left a comment
There was a problem hiding this comment.
second pr with suggestions https://github.com/weaveworks/weave-gitops/tree/add-cli-docs-eneko2
and the questions that still open from the previous review
* added persona and outcome * might be redundant * basic setup * basic setup * small fix for link
MostafaMegahid
left a comment
MostafaMegahid
left a comment
There was a problem hiding this comment.
The docs look good to me.
3 participants
Closes weaveworks/weave-gitops-enterprise#3406
Documentation Changes