diff --git a/docs/cli.md b/docs/cli.md index d664647d..173e9545 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -105,7 +105,7 @@ sb deploy [--docker-image] | Name | Default | Description | |-----------------------|-------------------------|-------------------------------------------------------------------------------| -| `--docker-image` `-i` | `superbench/superbench` | Docker image URI, [here](./user-tutorial/container-images) listed all images. | +| `--docker-image` `-i` | `superbench/superbench` | Docker image URI, [here](./user-tutorial/container-images.mdx) listed all images. | | `--docker-password` | `None` | Docker registry password if authentication is needed. | | `--docker-username` | `None` | Docker registry username if authentication is needed. | | `--host-file` `-f` | `None` | Path to Ansible inventory host file. | diff --git a/docs/developer-guides/contributing.md b/docs/developer-guides/contributing.md index 48783cd4..50ab4cc3 100644 --- a/docs/developer-guides/contributing.md +++ b/docs/developer-guides/contributing.md @@ -83,11 +83,11 @@ superbench-results #### Files to provide Besides `README` and `LICENSE` file, you should provide at least three benchmarking related files. -* `system.json`: This file lists all the system configurations in json format. +* `system.json`: This file lists all the system configurations in json format. You can get the system info automatically by executing `system_info.py` using below command. The file is under `superbench/tools` folder. ``` python system_info.py ``` -* `config.yaml`: This file is the config file to run benchmarks. Click [here](../getting-started/configuration) to learn the details. -* `result.json`: This file contains the results run by SuperBench with system configuations listed in `system.json` file. \ No newline at end of file +* `config.yaml`: This file is the config file to run benchmarks. Click [here](../getting-started/configuration.md) to learn the details. +* `result.json`: This file contains the results run by SuperBench with system configuations listed in `system.json` file. diff --git a/docs/developer-guides/development.md b/docs/developer-guides/development.md index 75a95eaa..26d9d456 100644 --- a/docs/developer-guides/development.md +++ b/docs/developer-guides/development.md @@ -11,7 +11,7 @@ You can also develop online with [GitHub Codespaces](https://github.com/codespac ## Check Environment -Follow [System Requirements](../getting-started/installation). +Follow [System Requirements](../getting-started/installation.mdx). ## Set Up diff --git a/docs/developer-guides/using-docker.mdx b/docs/developer-guides/using-docker.mdx index 2c3ab02f..621e9cff 100644 --- a/docs/developer-guides/using-docker.mdx +++ b/docs/developer-guides/using-docker.mdx @@ -13,7 +13,7 @@ here are the guides on how to build images and start containers during developme ## Build image -You need to [clone the code](./development#set-up) first before building the image. +You need to [clone the code](./development.md#set-up) first before building the image.