[Docs] Many docs improvements #2171
Conversation
| @@ -61,7 +61,7 @@ To use `dstack` with your own cloud accounts, create the `~/.dstack/server/confi | |||
| [configure backends](../reference/server/config.yml.md). | |||
| The server loads this file on startup. | |||
|
|
|||
| Alternatively, you can configure backends on the [project settings page](../concepts/projects/#project-backends) via the control plane's UI. | |||
| Alternatively, you can configure backends on the [project settings page](../guides/projects/#project-backends) via the control plane's UI. | |||
There was a problem hiding this comment.
Invalid link.
| Alternatively, you can configure backends on the [project settings page](../guides/projects/#project-backends) via the control plane's UI. | |
| Alternatively, you can configure backends on the [project settings page](administration.md#project-backends) via the control plane's UI. |
Btw, I'd expect mkdocs to fail on an invalid link. This should be revisited in #1603
| | `DSTACK_NODE_RANK` | The rank of the node | | ||
| | `DSTACK_MASTER_NODE_IP` | The internal IP address the master node | | ||
| | `DSTACK_NODES_IPS` | The list of internal IP addresses of all nodes delimited by "\n" | | ||
| ??? info "System environment variables" |
There was a problem hiding this comment.
There is a #system-environment-variables anchor on line 345 that does not work anymore because of this change
| @@ -267,77 +336,3 @@ environment, and its contents will persist across runs. | |||
| attach volumes to `/workflow` or any of its subdirectories. | |||
|
|
|||
| The `dev-environment` configuration type supports many other options. See below. | |||
There was a problem hiding this comment.
See below.
This is the last line of the document now, there is nothing below.
Same in task.md and service.md
| eos_token: "</s>" | ||
| ``` | ||
|
|
||
| ##### Limitations |
There was a problem hiding this comment.
Limitations is now part of the ToC because of toc_depth: 5.
I don't think it's supposed to be there, especially considering that clicking it doesn't work unless the TGI tab is open.
| @@ -1187,36 +276,127 @@ See the [reference table](#default-permissions) for all configurable permissions | |||
| cat my-service-account-file.json | jq -c | jq -R | |||
| ``` | |||
|
|
|||
| ## `projects[n].backends[type=kubernetes].networking` { #_networking data-toc-label="networking" } | |||
| ###### `projects[n].backends[type=kubernetes].networking` { #kuberentes-networking data-toc-label="networking" } | |||
There was a problem hiding this comment.
This typo leads to an invalid anchor link.
| ###### `projects[n].backends[type=kubernetes].networking` { #kuberentes-networking data-toc-label="networking" } | |
| ###### `projects[n].backends[type=kubernetes].networking` { #kubernetes-networking data-toc-label="networking" } |
| > The `dstack` server allows you to configure backends for multiple projects. | ||
| > If you don't need multiple projects, use only the `main` project. |
There was a problem hiding this comment.
(nit) This note looks out of place here. Consider moving to the top of the reference or removing.
docs/docs/concepts/backends.md
Outdated
| `dstack` can provision and manage compute across a variety of providers. | ||
|
|
||
| To use `dstack` with specific providers, configure backends in the | ||
| `~/.dstack/server/config.yml` file before starting the server. |
There was a problem hiding this comment.
(nit) Consider linking this page to the reference, e.g. here.
| `~/.dstack/server/config.yml` file before starting the server. | |
| [`~/.dstack/server/config.yml`](../reference/server/config.yml.md) file before starting the server. |
|
@jvstme Pushed more changes to ensure concepts pages include all important examples |
Fixes #2170