Skip to content

[UI] Minor update of help messages #2690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olgenn merged 1 commit into from
May 25, 2025
Merged

[UI] Minor update of help messages #2690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/docs/reference/server/config.yml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ to configure [backends](../../concepts/backends.md) and other [sever-level setti
overrides:
show_root_heading: false
backends:
type: 'Union[AWSBackendConfigWithCreds, AzureBackendConfigWithCreds, GCPBackendConfigWithCreds, LambdaBackendConfigWithCreds, NebiusBackendConfigWithCreds, RunpodBackendConfigWithCreds, TensorDockBackendConfigWithCreds, VastAIBackendConfigWithCreds, KubernetesConfig]'
type: 'Union[AWSBackendConfigWithCreds, AzureBackendConfigWithCreds, GCPBackendConfigWithCreds, LambdaBackendConfigWithCreds, NebiusBackendConfigWithCreds, RunpodBackendConfigWithCreds, VastAIBackendConfigWithCreds, KubernetesConfig]'

#### `projects[n].backends` { #backends data-toc-label="backends" }

Expand Down Expand Up @@ -194,7 +194,7 @@ to configure [backends](../../concepts/backends.md) and other [sever-level setti
type:
required: true

##### `projects[n].backends[type=tensordock]` { #tensordock data-toc-label="tensordock" }
<!-- ##### `projects[n].backends[type=tensordock]` { #tensordock data-toc-label="tensordock" }

#SCHEMA# dstack._internal.core.backends.tensordock.models.TensorDockBackendConfigWithCreds
overrides:
Expand All @@ -209,7 +209,7 @@ to configure [backends](../../concepts/backends.md) and other [sever-level setti
overrides:
show_root_heading: false
type:
required: true
required: true -->

##### `projects[n].backends[type=oci]` { #oci data-toc-label="oci" }

Expand Down
15 changes: 11 additions & 4 deletions frontend/src/pages/Project/Backends/Table/constants.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
import React from 'react';

export const BACKENDS_HELP_SKY = {
header: <h2>SKy Backends</h2>,
header: <h2>Backends</h2>,
body: (
<>
<p>Some text</p>
<p>To use <code>dstack</code> with cloud providers, you have to configure backends.</p>
<h4>Marketplace</h4>
<p>By default, <code>dstack Sky</code> includes a preset of backends that let you access compute from the {' '}
<code>dstack</code> marketplace and pay through your <code>dstack Sky</code> user billing.</p>
<h4>Your own cloud accounts</h4>
<p>You can also configure custom backends to use your own cloud providers, either instead of or in addition to the default ones.</p>
<p>See the <a href={'https://dstack.ai/docs/concepts/backends'} target='_blank'>documentation</a> for the list of supported backends.</p>
</>
),
};

export const BACKENDS_HELP_ENTERPRISE = {
header: <h2>Enterprise Backends</h2>,
header: <h2>Backends</h2>,
body: (
<>
<p>Some text</p>
<p>To use <code>dstack</code> with cloud providers, you have to configure backends.</p>
<p>See the <a href={'https://dstack.ai/docs/concepts/backends'} target='_blank'>documentation</a> for the list of supported backends.</p>
</>
),
};
6 changes: 3 additions & 3 deletions frontend/src/pages/Project/Backends/YAMLForm/constants.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ export const CONFIG_YAML_HELP_SKY = {
</p>
<p>
You can see all supported backend types at the{' '}
<a href={'https://dstack.ai/docs/reference/server/config.yml/#examples'} target={'_blank'}>
<a href={'https://dstack.ai/docs/concepts/backends'} target={'_blank'}>
documentation
</a>
.
</p>
<h4>Your own cloud account</h4>
<p>
If you want to use your own cloud account, configure <code>creds</code> and other settings according to the{' '}
<a href={'https://dstack.ai/docs/reference/server/config.yml/#examples'} target={'_blank'}>
<a href={'https://dstack.ai/docs/concepts/backends'} target={'_blank'}>
documentation
</a>
. Example:
Expand Down Expand Up @@ -68,7 +68,7 @@ export const CONFIG_YAML_HELP_ENTERPRISE = {
</p>
<p>
Each backend type may support different properties. See the{' '}
<a href={'https://dstack.ai/docs/reference/server/config.yml/#examples'}>reference page</a> for more examples.
<a href={'https://dstack.ai/docs/concepts/backends'} target='_blank'>documentaiton</a> for more examples.
</p>
</>
),
Expand Down
10 changes: 9 additions & 1 deletion frontend/src/pages/Project/Details/Settings/constants.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ export const CLI_INFO = {
header: <h2>CLI</h2>,
body: (
<>
<p>Some text</p>
<p>
To use this project with your CLI, add it using the
<a href={'https://dstack.ai/docs/reference/cli/dstack/project/'} target='_blank'>
<code>dstack project add</code></a> command.
</p>
<p>
To learn how to install the CLI, refer to the{' '}
<a href={'https://dstack.ai/docs/cli/installation'} target='_blank'>installation</a> guide.
</p>
</>
),
};
3 changes: 2 additions & 1 deletion frontend/src/pages/Project/Gateways/Table/constants.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ export const GATEWAYS_INFO = {
header: <h2>Gateways</h2>,
body: (
<>
<p>Some text</p>
<p>Gateways manage the ingress traffic for running services.</p>
<p>To learn more about gateways, see the <a href={'https://dstack.ai/docs/concepts/gateways'} target='_blank'>documentation</a>.</p>
</>
),
};
Loading