Skip to content

The documentation style might be outdated on breaking lines #477

Open
@krassowski

Description

@krassowski

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    • Status

      Todo 📬

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions