mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-11-01 05:51:36 +08:00
New Crowdin translations - zh-CN (#26553)
Co-authored-by: Crowdin Bot <support+bot@crowdin.com>
This commit is contained in:
PX4 Build Bot
co-authored by
Crowdin Bot
Crowdin Bot
parent
102b64f604
commit
62d0620eff
@@ -7,7 +7,7 @@ const { site } = useData();
|
||||
|
||||
<div v-if="site.title !== 'PX4 Guide (main)'">
|
||||
<div class="custom-block danger">
|
||||
<p class="custom-block-title">This page may be out out of date. <a href="https://docs.px4.io/main/en/contribute/dev_call.html">See the latest version</a>.</p>
|
||||
<p class="custom-block-title">This page may be out of date. <a href="https://docs.px4.io/main/en/contribute/dev_call">See the latest version</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -36,4 +36,4 @@ Please add your topics for discussion to the agenda before the meeting begins, b
|
||||
## 日程
|
||||
|
||||
- TIME: Wednesday 17h00 CET ([subscribe to calendar](https://dronecode.org/calendar/))
|
||||
- **Join the call**: [https://discord.gg/BDYmr6FA6Q](https://discord.gg/BDYmr6FA6Q)
|
||||
- **Join the call**: [https://discord.com/invite/BDYmr6FA6Q](https://discord.com/invite/BDYmr6FA6Q)
|
||||
|
||||
@@ -55,7 +55,7 @@ If you already have a clone of the [PX4-Autopilot](https://github.com/PX4/PX4-Au
|
||||
指南使用 <a href="https://legacy.gitbook.com/">旧版Gitbook 工具链</a>
|
||||
The instructions below explain how to get git and use it on your local computer.
|
||||
|
||||
1. Download git for your computer from [https://git-scm.com/downloads](https://git-scm.com/downloads)
|
||||
1. Download git for your computer from [https://git-scm.com/downloads/](https://git-scm.com/downloads/)
|
||||
|
||||
2. [Sign up](https://github.com/signup) for Github if you haven't already
|
||||
|
||||
@@ -83,10 +83,10 @@ The instructions below explain how to get git and use it on your local computer.
|
||||
6. Add a _remote_ called "upstream" to point to the "official" PX4 version of the library:
|
||||
|
||||
```sh
|
||||
git remote add upstream https://github.com/PX4/PX4-Autopilot.git
|
||||
git remote add upstream https://github.com/PX4/PX4-Autopilot
|
||||
```
|
||||
|
||||
:::tip
|
||||
::: tip
|
||||
A "remote" is a handle to a particular repository.
|
||||
The remote named _origin_ is created by default when you clone the repository, and points to _your fork_ of the guide.
|
||||
Above you create a new remote _upstream_ that points to the PX4 project version of the documents.
|
||||
@@ -166,7 +166,9 @@ Within the repository you created above:
|
||||
yarn install
|
||||
```
|
||||
|
||||
4. Preview and serve the library:
|
||||
4. (Optional) [Build the docs for PX4 metadata](#building-px4-docs-metadata) if your source contains changes to parameter or module docs that you want to check.
|
||||
|
||||
5. Preview and serve the library:
|
||||
|
||||
```sh
|
||||
yarn start
|
||||
@@ -176,7 +178,7 @@ Within the repository you created above:
|
||||
This will be something like: `http://localhost:5173/px4_user_guide/`.
|
||||
- Stop serving using **CTRL+C** in the terminal prompt.
|
||||
|
||||
5. Open previewed pages in your local editor:
|
||||
6. Open previewed pages in your local editor:
|
||||
|
||||
First specify a local text editor file using the `EDITOR` environment variable, before calling `yarn start` to preview the library.
|
||||
For example, you can enable VSCode as your default editor by entering:
|
||||
@@ -195,7 +197,7 @@ Within the repository you created above:
|
||||
|
||||
The **Open in your editor** link at the bottom of each page will then open the current page in the editor (this replaces the _Open in GitHub_ link).
|
||||
|
||||
6. You can build the library as it would be done for deployment:
|
||||
7. You can build the library as it would be done for deployment:
|
||||
|
||||
```sh
|
||||
# Ubuntu
|
||||
@@ -210,6 +212,32 @@ Use `yarn start` to preview changes _as you make them_ (documents are updated an
|
||||
Before submitting a PR you should also build it using `yarn docs:build`, as this can highlight issues that are not visible when using `yarn start`.
|
||||
:::
|
||||
|
||||
#### Building PX4 docs metadata
|
||||
|
||||
PX4 Metadata is not automatically updated in the local docs tree when you make changes to source.
|
||||
This can result in broken links showing up during testing if you link to new parameters, modules, airframes, or other content that is generated from source.
|
||||
|
||||
You can generate the metadata and copy it into the tree on _Ubuntu_ (only) using the convenient yarn command:
|
||||
|
||||
```sh
|
||||
# Ubuntu
|
||||
yarn build_docs_metadata_ubuntu
|
||||
```
|
||||
|
||||
:::info
|
||||
The generated metadata docs should not be included in PRs as they will complicate reveiwing (metadata is automatically generated when a PR merges in main).
|
||||
It is not a problem if you do add such metadata, as it will be swamped on merge.
|
||||
:::
|
||||
|
||||
#### Check for broken links
|
||||
|
||||
You can use the following command to check for broken links in the whole document:
|
||||
|
||||
```sh
|
||||
# Ubuntu
|
||||
yarn linkcheck
|
||||
```
|
||||
|
||||
### Source Code Structure
|
||||
|
||||
The guide uses the [Vitepress](https://vitepress.dev/) toolchain.
|
||||
|
||||
@@ -22,7 +22,7 @@ Adding a feature to PX4 follows a defined workflow. In order to share your contr
|
||||
```sh
|
||||
cd PX4-Autopilot
|
||||
git submodule update --init --recursive
|
||||
git remote add upstream https://github.com/PX4/PX4-Autopilot.git
|
||||
git remote add upstream https://github.com/PX4/PX4-Autopilot
|
||||
```
|
||||
|
||||
- You should have now two remote repositories: One repository is called `upstream` that points to PX4/PX4-Autopilot, and one repository `origin` that points to your forked copy of the PX4 repository.
|
||||
@@ -49,7 +49,7 @@ Adding a feature to PX4 follows a defined workflow. In order to share your contr
|
||||
git add <file name>
|
||||
```
|
||||
|
||||
If you prefer having a GUI to add your files see [Gitk](https://git-scm.com/book/en/v2/Git-in-Other-Environments-Graphical-Interfaces) or [`git add -p`](https://nuclearsquid.com/writings/git-add/).
|
||||
If you prefer having a GUI to add your files see [Gitk](https://git-scm.com/book/en/v2/Appendix-A:-Git-in-Other-Environments-Graphical-Interfaces) or [`git add -p`](https://nuclearsquid.com/writings/git-add/).
|
||||
|
||||
- 提交添加的文件, 并顺便记录一条有意义的消息, 解释您的更改
|
||||
|
||||
@@ -59,7 +59,7 @@ Adding a feature to PX4 follows a defined workflow. In order to share your contr
|
||||
|
||||
For a good commit message, please refer to the [Source Code Management](../contribute/code.md#commits-and-commit-messages) section.
|
||||
|
||||
- Some time might have passed and the [upstream main](https://github.com/PX4/PX4-Autopilot.git) has changed.
|
||||
- Some time might have passed and the [upstream main](https://github.com/PX4/PX4-Autopilot) has changed.
|
||||
PX4 prefers a linear commit history and uses [git rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing).
|
||||
To include the newest changes from upstream in your local branch, switch to your main branch
|
||||
|
||||
@@ -139,7 +139,7 @@ To get the source code for a _specific older release_ (tag):
|
||||
1. Clone the PX4-Autopilot repo and navigate into _PX4-Autopilot_ directory:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/PX4/PX4-Autopilot.git
|
||||
git clone https://github.com/PX4/PX4-Autopilot
|
||||
cd PX4-Autopilot
|
||||
```
|
||||
|
||||
@@ -179,7 +179,7 @@ To get a release branch:
|
||||
- Clone the PX4-Autopilot repo and navigate into _PX4-Autopilot_ directory:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/PX4/PX4-Autopilot.git
|
||||
git clone https://github.com/PX4/PX4-Autopilot
|
||||
cd PX4-Autopilot
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ const { site } = useData();
|
||||
|
||||
<div v-if="site.title !== 'PX4 Guide (main)'">
|
||||
<div class="custom-block danger">
|
||||
<p class="custom-block-title">This page may be out out of date. <a href="https://docs.px4.io/main/en/contribute/">See the latest version</a>.</p>
|
||||
<p class="custom-block-title">This page may be out of date. <a href="https://docs.px4.io/main/en/contribute/">See the latest version</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ const { site } = useData();
|
||||
|
||||
<div v-if="site.title !== 'PX4 Guide (main)'">
|
||||
<div class="custom-block danger">
|
||||
<p class="custom-block-title">This page may be out out of date. <a href="https://docs.px4.io/main/en/contribute/support.html">See the latest version</a>.</p>
|
||||
<p class="custom-block-title">This page may be out of date. <a href="https://docs.px4.io/main/en/contribute/support">See the latest version</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -18,7 +18,7 @@ This section shows how you can get help from the core dev team and the wider com
|
||||
The core development team and community are active on the following channels:
|
||||
|
||||
- [PX4 Discuss Forum](https://discuss.px4.io/) - Post here first!
|
||||
- [PX4 Discord](https://discord.gg/dronecode) - Post here if you don't get a response in discuss within a few days (include a link to your forum topic).
|
||||
- [PX4 Discord](https://discord.com/invite/dronecode) - Post here if you don't get a response in discuss within a few days (include a link to your forum topic).
|
||||
|
||||
:::tip
|
||||
The Discuss Forum is much preferred because it is indexed by search engines and serves as a common knowledge base.
|
||||
|
||||
Reference in New Issue
Block a user