Skip to content

Doc file fixes#14608

Merged
fdncred merged 2 commits intonushell:mainfrom
NotTheDr01ds:doc-file-fixes
Dec 17, 2024
Merged

Doc file fixes#14608
fdncred merged 2 commits intonushell:mainfrom
NotTheDr01ds:doc-file-fixes

Conversation

@NotTheDr01ds
Copy link
Copy Markdown
Contributor

@NotTheDr01ds NotTheDr01ds commented Dec 17, 2024

Description

With great thanks to @fdncred and especially @PerchunPak (see #14601) for finding and fixing a number of issues that I pulled in here due to the filename changes and upcoming freeze.

This PR primarily fixes a poor wording choice in the new filenames and config command options. The fact that these were called sample_config.nu (etc.) and accessed via config --sample created a great deal of confusion. These were never intended to be used as-is as config files, but rather as in-shell documentation.

As such, I've renamed them:

  • sample_config.nu becomes doc_config.nu
  • sample_env.nu becomes doc_env.nu
  • config nu --sample becomes config nu --doc
  • config env --sample because config env --doc

Also the following:

  • Updates doc_config.nu with a few additional comment-fixes on top of @PerchunPak's changes.
  • Adds version numbers to all files - Will need to update the version script to add some files after this PR.
  • Additional doc on plugin and plugin_gc configuration which I had failed to previously completely update from the older wording
  • Updated the comments in the scaffold_*.nu files to point people to help config/help nu so that, if things change in the future, it will become more difficult for the comments to be outdated.

User-Facing Changes

Mostly doc.

config nu and config env changes update new behavior previously added in 0.100.1

Tests + Formatting

  • 🟢 toolkit fmt
  • 🟢 toolkit clippy
  • 🟢 toolkit test
  • 🟢 toolkit test stdlib

After Submitting

  • Update configuration chapter of doc
  • Update the blog entry on migrating config
  • Update bump-version.nu

@PerchunPak
Copy link
Copy Markdown
Contributor

Can we merge my PR instead, so I could get a contribution please 👉👈

@NotTheDr01ds
Copy link
Copy Markdown
Contributor Author

NotTheDr01ds commented Dec 17, 2024

Can we merge my PR instead, so I could get a contribution please 👉👈

That's why I was asking yesterday if you could get it down to just the error fixes. I would definitely have advocated for that to be merged. As it is, it still looks like it needs a lot of rollbacks. Like the indentation, changes to the plugin configs, nulls need to be removed.

As @fdncred said, we're running out of time. How quickly can you get that done?

It's going to be a lot of work to merge this back on top of that at this point.

@PerchunPak
Copy link
Copy Markdown
Contributor

How quickly can you get that done?

I can do this now, sorry I probably missed what you requested

@NotTheDr01ds
Copy link
Copy Markdown
Contributor Author

NotTheDr01ds commented Dec 17, 2024

@PerchunPak Thanks - If you can get that PR scaled back to just the critical fixes (mainly those that had colons instead of equal signs), along with any dangling space-removal, etc. I'd rebase and fix merge conflicts on top of that.

You can add the versions as well.

@fdncred
Copy link
Copy Markdown
Contributor

fdncred commented Dec 17, 2024

@NotTheDr01ds ping me when this is ready and i'll land it.

@NotTheDr01ds
Copy link
Copy Markdown
Contributor Author

@fdncred Thanks - Should be ready as soon as CI completes.

@fdncred fdncred merged commit c0ad659 into nushell:main Dec 17, 2024
@github-actions github-actions bot added this to the v0.101.0 milestone Dec 17, 2024
@NotTheDr01ds NotTheDr01ds deleted the doc-file-fixes branch December 18, 2024 03:09
@fdncred fdncred added A:configuration Issue related to nu's configuration deprecated:pr-commands (deprecated: too vague) This PR changes our commands in some way labels Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A:configuration Issue related to nu's configuration deprecated:pr-commands (deprecated: too vague) This PR changes our commands in some way

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants