Skip to content

Commit 648c2a4

Browse files
[Docs] Move Reference to a separate page for more space and better structure #2091 (#2092)
1 parent 683d1f8 commit 648c2a4

File tree

6 files changed

+30
-55
lines changed

6 files changed

+30
-55
lines changed

docs/assets/stylesheets/extra.css

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1276,37 +1276,25 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
12761276
display: none;
12771277
}
12781278

1279-
.md-tabs__item:nth-child(6) {
1280-
margin-left: auto;
1281-
}
1282-
12831279
.md-tabs__item:nth-child(7) {
1280+
margin-left: auto;
12841281
padding-right: 1.2rem;
12851282
}
12861283

1287-
.md-tabs__item:nth-child(n+6):nth-child(-n+7) .md-tabs__link {
1284+
.md-tabs__item:nth-child(n+7) .md-tabs__link {
12881285
visibility: hidden;
12891286
width: 35px;
12901287
display: inline-block;
12911288
margin-top: 10px;
12921289
}
12931290

1294-
.md-tabs__item:nth-child(n+6) .md-tabs__link:before {
1291+
.md-tabs__item:nth-child(n+7) .md-tabs__link:before {
12951292
width: 38px;
12961293
height: 38px;
12971294
margin-top: 4px;
12981295
visibility: visible;
12991296
}
13001297

1301-
.md-tabs__item:nth-child(8) .md-tabs__link:after {
1302-
content: url('data:image/svg+xml,<svg fill="black" xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewBox="0 0 16 16"><polygon points="5 4.31 5 5.69 9.33 5.69 2.51 12.51 3.49 13.49 10.31 6.67 10.31 11 11.69 11 11.69 4.31 5 4.31" data-v-e1bdab2c=""></polygon></svg>');
1303-
line-height: 14px;
1304-
margin-left: 4px;
1305-
position: relative;
1306-
top: 0;
1307-
margin-right: -7px;
1308-
}
1309-
13101298
.twemoji.external {
13111299
position: relative;
13121300
top: 2.5px;
@@ -1323,7 +1311,7 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
13231311
margin-right: -7px;
13241312
}
13251313

1326-
.md-tabs__item:nth-child(6) .md-tabs__link:before {
1314+
.md-tabs__item:nth-child(7) .md-tabs__link:before {
13271315
position: relative;
13281316
content: '';
13291317
width: 40px;
@@ -1337,20 +1325,6 @@ html .md-footer-meta.md-typeset a:is(:focus,:hover) {
13371325
margin-top: 0;
13381326
}
13391327

1340-
.md-tabs__item:nth-child(7) .md-tabs__link:before {
1341-
position: relative;
1342-
content: '';
1343-
width: 40px;
1344-
height: 35px;
1345-
display: inline-block;
1346-
-webkit-mask: url('data:image/svg+xml,<?xml version="1.0" encoding="utf-8"?><svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" viewBox="-30 -30 606 572"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg>') no-repeat 50% 50%;
1347-
mask: url('data:image/svg+xml,<?xml version="1.0" encoding="utf-8"?><svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" viewBox="-30 -30 606 572"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg>') no-repeat 50% 50%;
1348-
-webkit-mask-size: cover;
1349-
mask-size: cover;
1350-
background: -webkit-linear-gradient(45deg, black, black);
1351-
margin-top: 0;
1352-
}
1353-
13541328
.md-tabs__link {
13551329
display: flex;
13561330
align-items: center;

docs/docs/reference/server/config.yml.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ The `~/.dstack/server/config.yml` file is used
44
to [configure](../../installation/index.md#1-configure-backends) the `dstack` server cloud accounts
55
and other sever-level settings such as encryption.
66

7-
## Backends
7+
## Configure backends { #backends }
88

99
> The `dstack` server allows you to configure backends for multiple projects.
1010
> If you don't need multiple projects, use only the `main` project.
1111
1212
Each cloud account must be configured under the `backends` property of the respective project.
1313
See the examples below.
1414

15-
### Cloud providers
15+
### Cloud providers { #clouds }
1616

1717
#### AWS
1818

@@ -739,11 +739,11 @@ projects:
739739

740740
</div>
741741

742-
### On-prem servers
742+
### On-prem servers { #on-prem }
743743

744744
#### SSH fleets
745745

746-
For using `dstack` with on-prem servers, no backend configuration is required.
746+
> For using `dstack` with on-prem servers, no backend configuration is required.
747747
See [SSH fleets](../../concepts/fleets.md#ssh-fleets) for more details.
748748

749749
#### Kubernetes
@@ -836,7 +836,7 @@ In case of a self-managed cluster, also specify the IP address of any node in th
836836

837837
[//]: # (TODO: Provide short yet clear instructions. Elaborate on whether it works with Kind.)
838838

839-
## Encryption
839+
## Enable encryption { #encryption }
840840

841841
By default, `dstack` stores data in plaintext. To enforce encryption, you
842842
specify one or more encryption keys.

docs/overrides/header-2.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@
6161
{% endif %}-->
6262

6363
<div class="md-header__buttons">
64-
<a href="https://github.com/dstackai/dstack" target="_blank" class="md-button md-button--primary github">Star us</a>
65-
<a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord">Discord</a>
64+
<a href="https://github.com/dstackai/dstack" target="_blank" class="md-button md-button--primary github">GitHub</a>
65+
<!--<a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord">Discord</a>-->
6666
</div>
6767
</nav>
6868
{% if "navigation.tabs.sticky" in features %}

docs/overrides/header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
<div class="md-header__buttons">
5959
<a href="https://sky.dstack.ai" target="_blank" class="md-button md-button-secondary external borderless">dstack Sky</a>
6060
<a href="https://github.com/dstackai/dstack" target="_blank" class="md-button md-button--primary github">Star us</a>
61-
<a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord">Discord</a>
61+
<!--<a href="https://discord.gg/u8SmfwPpMd" target="_blank" class="md-button md-button-secondary discord">Discord</a>-->
6262
</div>
6363
</nav>
6464
{% if "navigation.tabs.sticky" in features %}

docs/overrides/main.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
<div class="tx-footer__section">
109109
<div class="tx-footer__section-title">Resources</div>
110110
<a href="/docs" class="tx-footer__section-link">Documentation</a>
111-
<a href="https://github.com/dstackai/dstack/releases" target="_blank" class="tx-footer__section-link external">What's new</a>
111+
<a href="https://github.com/dstackai/dstack/releases" target="_blank" class="tx-footer__section-link external">Changelog</a>
112112
<a href="/blog" class="tx-footer__section-link">Blog</a>
113113
</div>
114114

mkdocs.yml

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -217,22 +217,23 @@ nav:
217217
- Projects: docs/concepts/projects.md
218218
- Guides:
219219
- Protips: docs/guides/protips.md
220-
- Troubleshooting: docs/guides/troubleshooting.md
221220
- Server deployment: docs/guides/server-deployment.md
222-
- Reference:
221+
- Troubleshooting: docs/guides/troubleshooting.md
222+
- Reference:
223+
- .dstack.yml:
224+
- dev-environment: docs/reference/dstack.yml/dev-environment.md
225+
- task: docs/reference/dstack.yml/task.md
226+
- service: docs/reference/dstack.yml/service.md
227+
- fleet: docs/reference/dstack.yml/fleet.md
228+
- gateway: docs/reference/dstack.yml/gateway.md
229+
- volume: docs/reference/dstack.yml/volume.md
230+
- Server:
223231
- server/config.yml: docs/reference/server/config.yml.md
224-
- .dstack.yml:
225-
- dev-environment: docs/reference/dstack.yml/dev-environment.md
226-
- task: docs/reference/dstack.yml/task.md
227-
- service: docs/reference/dstack.yml/service.md
228-
- fleet: docs/reference/dstack.yml/fleet.md
229-
- gateway: docs/reference/dstack.yml/gateway.md
230-
- volume: docs/reference/dstack.yml/volume.md
231-
# - profiles.yml: docs/reference/profiles.yml.md
232-
- CLI: docs/reference/cli/index.md
233-
- API:
234-
- Python API: docs/reference/api/python/index.md
235-
- REST API: docs/reference/api/rest/index.md
232+
- CLI:
233+
- dstack: docs/reference/cli/index.md
234+
- API:
235+
- Python API: docs/reference/api/python/index.md
236+
- REST API: docs/reference/api/rest/index.md
236237
- Examples:
237238
- examples.md
238239
- Deployment:
@@ -250,10 +251,10 @@ nav:
250251
- Llama 3.2: examples/llms/llama32/index.md
251252
- Misc:
252253
- Docker Compose: examples/misc/docker-compose/index.md
254+
- Partners: partners.md
253255
- Blog:
254256
- blog/index.md
255-
- Partners: partners.md
257+
- Discord: https://discord.gg/u8SmfwPpMd" target="_blank
256258
# - Changelog: https://github.com/dstackai/dstack/releases" target="_blank
257-
# - Discord: https://discord.gg/u8SmfwPpMd" target="_blank
258259
# - GitHub: https://github.com/dstackai/dstack" target="_blank
259260
# - Sign in: https://sky.dstack.ai" target="_blank

0 commit comments

Comments
 (0)