-
Notifications
You must be signed in to change notification settings - Fork 150
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
WIP - Single install docs that simplify, streamline install process for both manual or cli #4178
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
You are a Platform Engineer who is in charge of installing Weave GitOps Enterprise in your organisation. We propose you | ||
to follow this itinerary to complete a successful installation: | ||
|
||
1. **Getting Started**: it's your day-0, and you want to get started quickly with limited knowledge for having a basic understanding on Weave GitOps Enterprise. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Getting for day 0 with basic experinces as we designed in the cli initative ... for example, anything oidc goes to day 1
|
||
- `CLI Interactive`: ideal if you have limited knowledge about the product and want guidance step-by-step. | ||
- `CLI Non-Interactive`: ideal if you are already familiar with Weave GitOps Enterprise and want to leverage the CLI for convenience. | ||
- `Manual`: ideal if you want to have full control on the process or your context cannot be handled via the CLI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if we aim for having a quick getting started, is the manual route useful in this case? or we should just aim for having cli-based getting started ?
::: | ||
|
||
You are a Platform Engineer who is in charge of installing Weave GitOps Enterprise in your organisation. We propose you | ||
to follow this itinerary to complete a successful installation: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBC: Consider whether there is a space for a different page quick start
and install
for targeting the different audience?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion:
- split content between days on different pages with navigation to next page to next day ...
you could use Manual route or use the CLI with the `--export` flag. | ||
::: | ||
|
||
<Tabs groupId="flux bootstrap" default> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
favour manual tabs by default as likely the user that comes is installing manually
also consider whether cli tab provides value?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From Mostafa: to only add cli tab when we are adding extra functionality for example oidc
// TODO add a recording | ||
|
||
```bash | ||
gitops bootstrap \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regarding non-interactive documentation we go for the following:
-
Here we add the main complete examples that allows us to get to WGE up and running for day-0 (less aim for 2 - 3 examples max):
-
a) I have already flux bootstrapped
-
b) I don't have flux bootstrapped and want bootstrapping via ssh
Any other cli tabs with configurations should only there when we are adding extra functionality to the manual version. clear example is odic that we have a sub-command.
For more information about the CLI configurations, check the below sections [here](#cli-configurations) | ||
|
||
</TabItem> | ||
<TabItem value="Manual OIDC" label="Manual OIDC"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this to day1
// TODO cli should automate creating any manual step for example the bases patterns and to validate that the setup is stable. | ||
::: | ||
|
||
<Tabs groupId="authorization" default> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion to simplify reading day0 is to move out also this informational stuff with the right linking to another part either apendix, sub-page ..
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
99785d9
to
405bbd4
Compare
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
Signed-off-by: Eneko Fernandez <eneko@weave.works>
This update includes dividing the enterprise getting started guide into two days with Day 1 for onboarding platform engineers and Day 2 for expanding capabilities. It helps the users to follow the flow more intuitively. It also includes the enabling process of write access to Git and cluster management via Cluster API. The move towards a day-by-day guide contributes to a more structured and digestible learning process. Signed-off-by: Eneko Fernandez <eneko@weave.works>
f327cd0
to
5217600
Compare
Changes include dividing the guide into steps rather than days and improving descriptions for more clarity. The restructuring allows users to follow the guide more intuitively, providing a clearer understanding of different stages, such as bootstrapping and authentication. The enhancement aims to provide a more structured and digestible learning experience. Signed-off-by: Eneko Fernandez <eneko@weave.works>
The documentation was restructured by breaking down the initial "Getting Started" guide into separate steps. These revisions allow users to more intuitively follow the process, improving clarity with enhanced descriptions for each stage such as bootstrapping and authentication. The intent behind these changes is to provide users with a more organized and understandable learning journey. Signed-off-by: Eneko Fernandez <eneko@weave.works>
Introduced a new 'Advanced Topics' page in the enterprise documentation. This page covers detailed information on OIDC customization, scopes, claims, Cluster User, User Permissions and how to customize the UI for users. It also improves the organization of our 'Getting Started' guide by breaking it down into step-by-step sections. This helps provide a clearer and better-structured journey for users. Signed-off-by: Eneko Fernandez <eneko@weave.works>
a4ba6b1
to
2daceb0
Compare
Signed-off-by: Eneko Fernandez <eneko@weave.works>
7f5dc47
to
a71a4c0
Compare
Closes
What changed?
Why was this change made?
How was this change implemented?
How did you validate the change?
Release notes
Documentation Changes