diff --git a/website/docs/assets/portal-arch.jpg b/website/docs/assets/portal-arch.jpg index 4b5acbf..9601444 100644 Binary files a/website/docs/assets/portal-arch.jpg and b/website/docs/assets/portal-arch.jpg differ diff --git a/website/docs/introduction.md b/website/docs/introduction.md index a27f1e4..ef42be2 100644 --- a/website/docs/introduction.md +++ b/website/docs/introduction.md @@ -45,8 +45,8 @@ A high level comparison between Litmus 1.x and Litmus 2.0 providing a holistic v ## Litmus quick access links -### Getting started with Litmus +### [Getting started with Litmus](prerequisite) -### Litmus features +### [Litmus features](gitops) -### Access Litmus API [here](https://litmuschaos.github.io/litmus/api.html) +### [Access Litmus API](https://litmuschaos.github.io/litmus/api.html) diff --git a/website/docs/myhub.md b/website/docs/myhub.md index b9521b6..dcd4091 100644 --- a/website/docs/myhub.md +++ b/website/docs/myhub.md @@ -1,11 +1,11 @@ --- id: myhub -title: My Hub -sidebar_label: My Hub +title: MyHub +sidebar_label: MyHub --- --- -My Hub allows a user to orchestrate workflows from the Public **[ChaosHub](http://hub.litmuschaos.io/)** or an alternate source for the Experiments (basically, a **[fork](https://github.com/litmuschaos/chaos-charts)** of the public source with custom experiments). +MyHub allows a user to orchestrate workflows from the Public **[ChaosHub](http://hub.litmuschaos.io/)** or an alternate source for the Experiments (basically, a **[fork](https://github.com/litmuschaos/chaos-charts)** of the public source with custom experiments). With this feature, a user can construct workflows by selecting, tuning and sequencing different experiments from their connected My Hubs. @@ -30,13 +30,13 @@ Personal Access Tokens are used as an alternative to the password for authentica Just like the Access Token , SSH keys are used for the authentication. These keys come in pairs, a public key that is shared with the Git Services and a private key that is stored with the user. SSH link of the repository should be provided if the user selects this method. -## Syncing a My Hub -If some changes are made into the git repository, the user can reflect those changes in the hub by selecting the **Refresh Hub** option from the My Hub card. +## Syncing a MyHub +If some changes are made into the git repository, the user can reflect those changes in the hub by selecting the **Refresh Hub** option from the MyHub card. -## Editing a My Hub -To make changes in a hub like changing the name, branch, access token etc, the user can select the **Edit Hub** option from the My Hub card. +## Editing a MyHub +To make changes in a hub like changing the name, branch, access token etc, the user can select the **Edit Hub** option from the MyHub card. -## Experiments in a My Hub +## Experiments in a MyHub ### 1. View the chart After connecting a hub, the user can view the different charts and the experiment. The charts are sorted according to different categories like generic, cassandra, kube-components etc. @@ -46,5 +46,5 @@ The experiment page consists of all the important details like the description o The user can also find experiment yaml link, RBAC link and the Chaos Engine yaml link of the experiment. These yaml links are required for the creation of Custom Chaos Workflows. -## Disconnect a My Hub -To remove a My Hub from a project, the user can select the **Disconnect Hub** option from the My Hub card. +## Disconnect a MyHub +To remove a MyHub from a project, the user can select the **Disconnect Hub** option from the MyHub card. diff --git a/website/docs/settings.md b/website/docs/settings.md index 2b881be..6282e7a 100644 --- a/website/docs/settings.md +++ b/website/docs/settings.md @@ -5,6 +5,13 @@ sidebar_label: Settings --- --- +Settings section allows a user to manage user related information and settings. At highlevel the settings section can be classified into the following + +1. My Account +2. Team +3. User Management +4. GitOps + ## My Account @@ -12,7 +19,7 @@ Here you can edit your personal details such as full Name, email-id, and passwor **Note:** Edit Avatar feature will be available in the upcoming releases. -## Teaming +## Team Teaming is based on the following principles and each user can have one of the 3 user roles: 1. Owner @@ -25,7 +32,7 @@ Teaming is based on the following principles and each user can have one of the 3 - Editor: Can make changes to the project, like view, edit, delete and create the workflow schedules - Settings page will not be visible to the user if he/she is browsing someone else’s project. The user can view the settings page if the user is the project owner. - + - On the teaming tab, owner can view the list of team members with other details including their role in the project, email-id, date-time of joining the team of the project. Owner can view/send/accept an invitation. Owner can remove a member from his/her project. User can also exit a project of which he/she is a part of. ## User Management