[Docs] Many docs improvements #2171
Conversation
| 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 |
# Conflicts: # docs/docs/concepts/fleets.md # docs/docs/dev-environments.md # docs/docs/services.md # docs/docs/tasks.md
There was a problem hiding this comment.
@peterschmidt85, everything looks good overall, but there are quite a few broken links, typos, and a couple of incorrect statements. Hope you can go through my comments before merging. Note that some comments from my previous review are still unresolved as well.
Feel free to ignore the nitpicking comments and let me know if you need any help fixing the links, etc.
I'd also greatly appreciate smaller PRs.
| @@ -0,0 +1,30 @@ | |||
| ### Creation policy | |||
There was a problem hiding this comment.
The ## header and the fleets definition are missing. They were present previously and seem informative.
| ### Creation policy | |
| ## Manage fleets | |
| Fleets are groups of cloud instances or SSH machines that you use to run dev environments, tasks, and services. | |
| You can let `dstack apply` provision fleets or [create and manage them directly](fleets.md). | |
| ### Creation policy |
There was a problem hiding this comment.
manage-fleets.ext is included in dev environments, tasks, and services. That's why the header and fleet definitions are intentionally skipped.
There was a problem hiding this comment.
Why not include it with the ## Manage fleets header? The way you do in manage-runs.ext, which does have the ## Manage runs header.
The ## Manage fleets header was present in the dev-envs, tasks, and services pages previously but was lost in this PR.
For example, this is what the Tasks page used to look like:
And this is what it looks like now:
Are you sure this is intentional?
There was a problem hiding this comment.
At least from my side, this was intentional - to remove "Manage fleets" from these pages. The idea is not to have a dedicated fleet section. We don't have for volumes right? We only mention briefly fleet related options because they relate to "Run a configuration".
Co-authored-by: jvstme <[email protected]>
Co-authored-by: jvstme <[email protected]>
Co-authored-by: jvstme <[email protected]>
Co-authored-by: jvstme <[email protected]>
Co-authored-by: jvstme <[email protected]>
Co-authored-by: jvstme <[email protected]>
Co-authored-by: jvstme <[email protected]>
Co-authored-by: jvstme <[email protected]>
|
@jvstme Fixed all except one (see above). If all is OK, I'm happy to merge. OK? |
@peterschmidt85, not quite, there are 21 more unresolved comments. |
Okay, seems like the PR is too messy. I will fix them in a separate commit |
Fixes #2170