Skip to content

Many minor improvements to docs and examples#2013

Merged
peterschmidt85 merged 2 commits intomasterfrom
minor-docs-edits
Nov 20, 2024
Merged

Many minor improvements to docs and examples#2013
peterschmidt85 merged 2 commits intomasterfrom
minor-docs-edits

Conversation

@peterschmidt85
Copy link
Copy Markdown
Contributor

  • [Examples] Deleted dev environment configs
  • [Docs/Examples] Updated service instructions
  • [Examples] Deleted some outdated examples (QLoRA, Mixtral, TEI)
  • [Examples] Updated TPU/AMD examples structure to make it a bit simpler
  • [Examples] If only one config in the folder, using .dstack.yml file notation
  • [Examples] Renamed build configurations file names (AMD)
  • [Examples] Replaced Ollama with NIM in Llama 3.1
  • [Docs] Updated Protips (simplifies Tasks vs. Services)

- [Docs/Examples] Updated service instructions
- [Examples] Deleted some outdated examples (QLoRA, Mixtral, TEI)
- [Examples] Updated TPU/AMD examples structure to make it a bit simpler
- [Examples] If only one config in the folder, using `.dstack.yml` file notation
- [Examples] Renamed build configurations file names (AMD)
- [Examples] Replaced Ollama with NIM in Llama 3.1
- [Docs] Updated Protips (simplifies Tasks vs. Services)
Comment on lines 103 to 108
!!! info "Gateway"
To enable [auto-scaling](reference/dstack.yml/service.md#auto-scaling), or use a custom domain with HTTPS,
set up a [gateway](concepts/gateways.md) before running the service.
If you're using [dstack Sky :material-arrow-top-right-thin:{ .external }](https://sky.dstack.ai){:target="_blank"},
a gateway is pre-configured for you.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(nit) Considering the text above no longer describes services, mentioning gateways looks irrelevant

Suggested change
!!! info "Gateway"
To enable [auto-scaling](reference/dstack.yml/service.md#auto-scaling), or use a custom domain with HTTPS,
set up a [gateway](concepts/gateways.md) before running the service.
If you're using [dstack Sky :material-arrow-top-right-thin:{ .external }](https://sky.dstack.ai){:target="_blank"},
a gateway is pre-configured for you.

@peterschmidt85 peterschmidt85 merged commit 08c642f into master Nov 20, 2024
@peterschmidt85 peterschmidt85 deleted the minor-docs-edits branch November 20, 2024 09:24
superprat pushed a commit to bahaal-tech/dstack that referenced this pull request Dec 20, 2024
* - [Examples] Deleted dev environment configs
- [Docs/Examples] Updated service instructions
- [Examples] Deleted some outdated examples (QLoRA, Mixtral, TEI)
- [Examples] Updated TPU/AMD examples structure to make it a bit simpler
- [Examples] If only one config in the folder, using `.dstack.yml` file notation
- [Examples] Renamed build configurations file names (AMD)
- [Examples] Replaced Ollama with NIM in Llama 3.1
- [Docs] Updated Protips (simplifies Tasks vs. Services)

* - [Docs] Addressing review feedback by @jvstme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants