diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 59e229bd8c6..8496cbd0d3b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -12,19 +12,18 @@ These pages are generated automatically from the internal help in each command's
This website is based on VuePress.
## Getting started
+
### One-time Setup
-1. First of all, make sure you have installed `node.js`(v18.12.0 or above)
-1. Create a fork of the (website repository)(https://github.com/nushell/nushell.github.io)
+1. [Fork the website repository](https://github.com/nushell/nushell.github.io/fork)
1. Clone the doc repo locally:
```nu
git clone git@github.com:nushell/nushell.github.io.git nu-docs
```
-
-1. [Install Node.js](https://nodejs.org/en/download/), the minimum version required: v18.12.0
-2. Run `npm install` in the root of the local repo after cloning to install the required dependencies for the dev server. This will also be necessary if any dependencies change.
+1. [Install Node.js](https://nodejs.org/en/download/) (minimum version required: v18.12.0)
+1. Run `npm install` in the root of the local repo after cloning to install the required dependencies for the dev server. This will also be necessary if any dependencies change.
### For each group of changes
@@ -41,9 +40,9 @@ This website is based on VuePress.
```
1. If you're adding a new page to the book, to make it appear, put it also to `.vuepress/configs/sidebar/{locale}.ts`.
-2. Make changes
-3. Verify your local changes render correctly using a web browser pointing to the local dev server site
-4. Commit and push your changes
+1. Make changes
+1. Verify your local changes render correctly by opening in a web browser and navigating to the new or changed pages
+1. Commit and push your changes
```nu
git commit -m "Commit Message"
@@ -52,23 +51,24 @@ This website is based on VuePress.
(Where `my_changes` is the current branch)
-5. Create a pull request in this GitHub repo
+1. Create a pull request in this GitHub repo
## Enabling a Preview URL From Your Fork
Just enable GitHub actions in your repo settings. That's all! It will start deploying the next time you push to `main`.
-
### Display Nu Code Snippets With Syntax Highlighting
-To display Nushell code snippets with syntax highlighting support you can wrap the Nu codes with \```nu \``` or \```nushell \```, for example:
+To display Nushell code snippets with syntax highlighting support you can wrap the Nu codes with `` ```nu ``` `` or `` ```nushell ``` ``, for example:
+````plain
```nu
# List the top five largest files
ls | where type == file | sort-by -r size | first 5
```
+````
-The preferred form for consistency is \```nu
+The preferred form for consistency is `` ```nu ``.
## Translation Guide
@@ -76,32 +76,31 @@ Follow the steps above for each group of translations.
### Adding to or updating existing translations
-* Check outdated translations. A helper script is provided for this. From the repository root, run:
+Check outdated translations. A helper script is provided for this. From the repository root, run:
```nu
nu tools/i18n.nu outdated zh-CN
```
- This will provide a list of all files that have been changed or added since the last translation update for the specified locale.
-
+This will provide a list of all files that have been changed or added since the last translation update for the specified locale.
### Creating a new translation
1. Add a book dir for the specified locale in the docs' root folder, say `zh-CN`.
1. Create a `book` child folder for all your translated documents and a README.md for the home page of your locale
-4. Modify the VuePress config file `.vuepress/config.js` and add `zh-CN` related configs.
+1. Modify the VuePress config file `.vuepress/config.js` and add `zh-CN` related configs.
- Here is an example [commit](https://github.com/nushell/nushell.github.io/commit/46d1672) for reference.
+ Here is an [example commit](https://github.com/nushell/nushell.github.io/commit/46d1672) for reference.
-5. Add a `README.md` in the `book` dir which will be the default introduction page of Nushell.
+1. Add a `README.md` in the `book` dir which will be the default introduction page of Nushell.
::: warning Important
Please **DO NOT** translate the file name of the docs.
:::
-6. Run `npm run dev`, then open **http://localhost:8080/** in your browser
+1. Run `npm run dev`, then open in your browser
1. Switch to the language you are going to translate into, and you will see the introduction page you have just created. You can translate the docs and save them to get a preview in the browser.
-7. Update the `i18n-meta.json` file by filling in the locale value of the doc you have just finished. It's recommended to use `commit_id@author` or simply a `commit_id` to indicate your translation end to the specified commit.
-8. Commit your changes. It's recommended to squash all your commits in one commit with a commit message like this: `Translate your_doc_file.md to zh-CN from commit: f3dc86d3d`;
-9. Push your changes as documented above
+1. Update the `i18n-meta.json` file by filling in the locale value of the doc you have just finished. It's recommended to use `commit_id@author` or simply a `commit_id` to indicate your translation end to the specified commit.
+1. Commit your changes. It's recommended to squash all your commits in one commit with a commit message like this: `Translate your_doc_file.md to zh-CN from commit: f3dc86d3d`;
+1. Push your changes as documented above
diff --git a/book/dataframes.md b/book/dataframes.md
index 04a27300f7f..3d090ffe7f5 100644
--- a/book/dataframes.md
+++ b/book/dataframes.md
@@ -1,7 +1,7 @@
# Dataframes
::: warning Important!
-This feature requires the Polars plugin. See the the
+This feature requires the Polars plugin. See the
[Plugins Chapter](plugins.md) to learn how to install it.
To test that this plugin is properly installed, run `help polars`.
@@ -61,7 +61,7 @@ The dataset has 5 columns and 5,429,252 rows. We can check that by using the
```
::: tip
-As of nushell 0.97, `polars open` will open as a lazy dataframe instead of a eager dataframe.
+As of nushell 0.97, `polars open` will open as a lazy dataframe instead of a eager dataframe.
To open as an eager dataframe, use the `--eager` flag.
:::
@@ -135,7 +135,7 @@ And the result from the benchmark is:
```nu
bench -n 10 --pretty {
- python load.py | null
+ python load.py | complete | null
}
```
diff --git a/package-lock.json b/package-lock.json
index 18e4286e273..eee083fd44e 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -3977,12 +3977,13 @@
]
},
"node_modules/micromatch": {
- "version": "4.0.5",
- "resolved": "https://registry.npmmirror.com/micromatch/-/micromatch-4.0.5.tgz",
- "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==",
+ "version": "4.0.8",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
+ "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
"dev": true,
+ "license": "MIT",
"dependencies": {
- "braces": "^3.0.2",
+ "braces": "^3.0.3",
"picomatch": "^2.3.1"
},
"engines": {