Skip to content

Latest commit

 

History

History
 
 

docs

Testkube docs

You can find the docs here: https://docs.testkube.io

How to edit the docs

System requirements:

If you're editing the docs, follow this workflow:

  1. Install dependencies with npm install
  2. Spin up local development with npm run start
  3. Update the docs inside the /docs folder
  4. Make sure to add the new document in the sidebar.json file:
{
  type: "category",
  label: "Concepts",
  items: [
    {
      type: "category",
      label: "Tests",
      items: [
        "concepts/tests/tests-creating",
        "concepts/tests/tests-running",
        "concepts/tests/tests-getting-results",
        "concepts/tests/tests-variables",
+       "concepts/new-concept"
      ],
    },
}
  1. You can preview the changes locally in your browser: http://localhost:3000

How to style the docs

Warning signs

If you want to add a warning/info message like the below, use Docusuarus Admonitions.

Warning signs

Code blocks title

If the content of the code blocks refers to a file, use Docusaurus Code Block title.

Code Block title

Don't:

file.js

```js
file
content
```

Do:

```js title="file.js"
file
content
```