Skip to content

Commit

Permalink
Config Preview Updates (#1690)
Browse files Browse the repository at this point in the history
* Update config recommendations for 0.101

* Editor examples

* Typo

* Move preview Configuration chapter live for 0.101

---------

Co-authored-by: Stefan Holderbach <[email protected]>
  • Loading branch information
NotTheDr01ds and sholderbach authored Dec 22, 2024
1 parent 4f877de commit 6e980c7
Show file tree
Hide file tree
Showing 3 changed files with 590 additions and 809 deletions.
7 changes: 2 additions & 5 deletions blog/2024-12-04-configuration_preview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Today, we're releasing two documentation items related to these changes:

- A guide to upgrading your configuration to take advantage of the enhancements (below). This will also be linked from the 0.101 Release Notes when it becomes available.

- A [preview of the new Configuration chapter](/book/configuration_preview.md) of the Book. This chapter has been rewritten to match the new functionality, as well as add some previously missing documentation on features like autoload dirs (and more). Once 0.101 releases, this will replace the previous configuration chapter. We welcome reviews of the updates, and any corrections or enhancements can be submitted to [the doc repository](https://github.com/nushell/nushell.github.io) if needed.
- A [<s>preview of the</s> (now live) new Configuration chapter](/book/configuration) of the Book. This chapter has been rewritten to match the new functionality, as well as add some previously missing documentation on features like autoload dirs (and more). Once 0.101 releases, this will replace the previous configuration chapter. We welcome reviews of the updates, and any corrections or enhancements can be submitted to [the doc repository](https://github.com/nushell/nushell.github.io) if needed.

---

Expand Down Expand Up @@ -126,8 +126,7 @@ $env.config.history = {
- The commented, sample `default_env.nu` and `default_config.nu` in older releases was useful for learning about configuration options. Since these (long) files are no longer copied to the filesystem, you can access an enhanced version of this documentation using:

```nu
config env --sample | nu-highlight | less -R
config nu --sample | nu-highlight | less -R
config nu --doc | nu-highlight | less -R
```

- Skeleton config files (`env.nu` and `config.nu`) are automatically created when the default config directory is created. Usually this will be the first time Nushell is started. The user will no longer be asked whether or not to create the files.
Expand All @@ -136,8 +135,6 @@ $env.config.history = {

- An internal `default_env.nu` is loaded immediately before the user's `env.nu`. You can inspect its contents using `config env --default | nu-highlight | less -R`.

This means that, as with `config.nu`, you can also use your `env.nu` to just override the default environment variables if desired.

- Likewise, a `default_config.nu` is loaded immediately before the user's `config.nu`. View
this file using `config nu --default | nu-highlight | less -R`.

Expand Down
Loading

0 comments on commit 6e980c7

Please sign in to comment.