Skip to content
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.

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

The documentation style might be outdated on breaking lines #477

Open
krassowski opened this issue Jun 17, 2024 · 0 comments
Open

The documentation style might be outdated on breaking lines #477

krassowski opened this issue Jun 17, 2024 · 0 comments
Labels
needs: triage 🚦 Someone needs to have a look at this issue and triage type: bug 🐛 Something isn't working

Comments

@krassowski
Copy link
Member

Describe the bug

The documentation style mentions:

- **Break up long lines in code snippets** with "`\`" for better readability. For example, see the code block in [Automatic DNS provision](../how-tos/domain-registry#automatic-dns-provision).

but the linked location does not have a line break link that:

## Automatic DNS provision
Nebari also supports management and the creation of the DNS records for you automatically. For automatic DNS provision add `dns.auto_provision` to your Nebari config file:
```yaml
dns:
provider: cloudflare
auto_provision: true
```
This will set the DNS provider as Cloudflare and automatically handle the creation or updates to the Nebari domain DNS records on Cloudflare.
:::warning
The usage of `dns.auto_provision` is restricted to Cloudflare as it is the only fully integrated DNS provider that Nebari currently supports.
:::
:::warning
Earlier version of Nebari supports dns settings through `--dns-provider` and `--dns-auto-provision` flags in the `deploy` command. But this feature is removed in favor of using the `nebari-config.yaml` file.
:::
When you are done setting up the domain name, you can refer back to the [Nebari deployment documentation][nebari-deploy] and continue the remaining steps.

Expected behavior

Example is embedded in the style guide instead to avoid link to

How to Reproduce the problem?

Visit https://www.nebari.dev/docs/community/style-guide/

Command output

No response

Versions and dependencies used.

No response

Anything else?

No response

@krassowski krassowski added type: bug 🐛 Something isn't working needs: triage 🚦 Someone needs to have a look at this issue and triage labels Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs: triage 🚦 Someone needs to have a look at this issue and triage type: bug 🐛 Something isn't working
Projects
Status: Todo 📬
Development

No branches or pull requests

1 participant