-
Notifications
You must be signed in to change notification settings - Fork 463
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix dataframe python example (#1593)
Also: - tidy/clarify contributing doc - bump micromatch to address npm audit warning
- Loading branch information
1 parent
fdb5c24
commit 71b98f9
Showing
3 changed files
with
29 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 [email protected]: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 <http://localhost:8080/> 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,56 +51,56 @@ 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 | ||
|
||
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 <http://localhost:8080/> 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.