Skip to content

Commit 6b430bb

Browse files
Use docusaurous admonitions
1 parent 3154594 commit 6b430bb

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/getting-started/quick-start-guide.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ To begin the installation, run:
4646
{`./install.sh --openchoreo-version ${versions.helmChart}`}
4747
</CodeBlock>
4848

49-
**💡 Tip:** If you previously used this setup and encounter errors during installation, ensure you perform the proper cleanup as outlined in the [Cleaning up](#cleaning-up) section before starting again.
49+
:::tip
50+
This installation script is idempotent - you can safely run it multiple times without issues. If you exit the dev container or stop the process at any point, simply restart the container and re-run the script to continue where you left off.
51+
:::
5052

5153
Once the installation is complete, you will see the following confirmation message:
5254
```text
@@ -95,10 +97,12 @@ Once the installation is complete, you will see the following confirmation messa
9597
======================================================================
9698
```
9799

98-
**📝 Note:** If you see any components are still in the `pending` state, you can check the status again in few minutes. Run the following command to check the installation status of components:
100+
:::note
101+
If you see any components are still in the `pending` state, you can check the status again in few minutes. Run the following command to check the installation status of components:
99102
```bash
100103
./check-status.sh
101104
```
105+
:::
102106

103107
#### Accessing the Backstage Developer Portal
104108

@@ -180,9 +184,13 @@ To inspect these resources in more detail, run the following commands:
180184
kubectl get components
181185
```
182186

183-
**💡 Tip:** You can try out more samples on this setup. Check out our <Link to={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples`}>Samples</Link> for more details. The samples are also available in the dev container at `/samples`.
187+
:::tip
188+
You can try out more samples on this setup. Check out our <Link to={`https://github.com/openchoreo/openchoreo/tree/${versions.githubRef}/samples`}>Samples</Link> for more details. The samples are also available in the dev container at `/samples`.
189+
:::
184190

185-
**⚠️ Important:** If you try out samples in the dev container, you don't need to expose the OpenChoreo Gateway to your host machine. The OpenChoreo gateway is already exposed to host machine via dev container port 8443.
191+
:::important
192+
If you try out samples in the dev container, you don't need to expose the OpenChoreo Gateway to your host machine. The OpenChoreo gateway is already exposed to host machine via dev container port 8443.
193+
:::
186194

187195
### Cleaning up
188196
After finishing your work, you have two options:

0 commit comments

Comments
 (0)