Skip to content

Commit

Permalink
fix: Fix two small bugs in the docs (#451)
Browse files Browse the repository at this point in the history
## Description:
Fixes two small bugs in the docs

## Is this change user facing?
YES

---------

Co-authored-by: mieubrisse <mieubrisse@gmail.com>
  • Loading branch information
mieubrisse and mieubrisse committed Apr 2, 2023
1 parent dbe4f5b commit d960dee
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -6,7 +6,7 @@ What is Kurtosis?
=================
[Kurtosis](https://www.kurtosis.com) is a composable build system for multi-container test environments. Kurtosis makes it easier for developers to set up test environments that require dynamic setup logic (e.g. passing IPs or runtime-generated data between services) or programmatic data seeding.

To read more about "why Kurtosis?", go [here](https://docs.kurtosis.com/explanations/what-is-kurtosis).
To read more about "why Kurtosis?", go [here](https://docs.kurtosis.com/#why-use-kurtosis).

To read about the architecture, go [here](https://docs.kurtosis.com/explanations/architecture).

Expand All @@ -19,7 +19,7 @@ Running Kurtosis
Follow the instructions [here](https://docs.kurtosis.com/install).

### Run
Kurtosis create ephemeral multi-container environments called [enclaves][enclave] using [Starlark](https://docs.kurtosis.com/explanations/starlark). These can be bundled together into [packages](https://docs.kurtosis.com/reference/packages). Let's run one now:
Kurtosis create ephemeral multi-container environments called [enclaves][enclave] using [Starlark](https://docs.kurtosis.com/concepts-reference/starlark). These can be bundled together into [packages](https://docs.kurtosis.com/concepts-reference/packages). Let's run one now:

```bash
kurtosis run github.com/kurtosis-tech/awesome-kurtosis/redis-voting-app
Expand Down
2 changes: 1 addition & 1 deletion docs/docusaurus.config.js
Expand Up @@ -98,7 +98,7 @@ const config = {
dropdownActiveClassDisabled: true,
},
{
href: 'https://github.com/kurtosis-tech/kurtosis/issues/new?assignees=leeederek&labels=docs&template=docs-issue.yml&title=%5BDocs%5D%3A+',
href: 'https://github.com/kurtosis-tech/kurtosis/issues/new?assignees=leeederek&labels=docs&template=docs-issue.yml',
position: 'right',
label: 'Report Docs Issue',
},
Expand Down
1 change: 0 additions & 1 deletion docs/sidebars.js
Expand Up @@ -50,7 +50,6 @@ const sidebars = {
{type: 'autogenerated', dirName: 'starlark-reference'}
]
},
'client-libs-reference',
{
type: 'category',
label: 'Concepts Reference',
Expand Down

0 comments on commit d960dee

Please sign in to comment.