|Roman Bapst 93bc6e84b2 Update SUMMARY.md||5 years ago|
|assets||5 years ago|
|en||5 years ago|
|images||5 years ago|
|kr||5 years ago|
|zh||5 years ago|
|.gitignore||6 years ago|
|.travis.yml||5 years ago|
|LANGS.md||6 years ago|
|LICENSE||5 years ago|
|README.md||6 years ago|
|book.json||5 years ago|
|favicon.ico||6 years ago|
|redirects.json||5 years ago|
This repo contains the source code for the PX4 User Guide.
The guide is intended for people who want to:
Note: Developers who want to create new code for PX4 should read the PX4 Dev Guide.
The guide uses the Gitbook toolchain. Change requests can be either done on the Gitbook website or locally.
Everything you need to install and build Gitbook locally is explained in its toolchain documentation.
Contributions to this guide are very welcome!
If you just want to fix a typo or change a particular existing page you can edit the associated file on this site via the Github web UI.
You'll be prompted to create a separate branch and then guided to submit a pull request with the change.
If you want to add new pages or change the structure then you should use the git tools to clone the repository,
create a new branches for any changes, then submit a pull request to get the changes merged. You'll want to
install the toolchain and test changes locally before submitting.
Translations of this guide are much appreciated!
Note Gitbook supports translation as described here. Each language is independent and keeps all its documents in its own directory (named using it's international code - "en" for English, "es" for Spanish, etc.) The LANGS.md file in the root directory lists the language folders that Gitbook must build.
In order to keep all language-versions of the guide up to date and synchronised, we have the following policy/guidelines:
This is an English-first book.
The structure and documents should be the same for all languages (i.e. based on the English version).
All languages share the same images by default (do not duplicate the /image folder, unless you're changing/translating the image).
Translation changes are submitted to the repo in the same way as any other changes (fork the repo, make a branch for your changes, and create PRs of the branches to submit them into this repo).
Translation teams can organise themselves however they like as long as PRs are submitted using the above approach.
The following sections provide some more detailed guidelines.
The process straightforward:
Create and checkout a new branch for your language.
checkout -b add_translation_language_yourlanguagename
Copy the whole English folder (/en) and rename it to the appropriate language code (e.g. "es" for Spanish).
Note This ensures that you keep the same structure and documents as the original version.
Update LANGS.md with your language.
Translate the content in your language tree.
Tip Minimally complete the home page and the SUMMARY.md before submitting any PR request. Ideally do more!
Commit the changes and push them back to your own fork repo.
git add * git commit -m "Created a your_new_language translation" git push origin add_translation_language_yourlanguagename
On the Github interface, create a PR to submit your branch back to the master repo (a banner appears on Github that you can click when you visit the repo).
Translations can be updated like any other change to documentation: fork the repo, create a branch for your changes in your fork, then submit them back to the main repo as PRs.
We hope that translation owners will track changes in the English version and propagate them through to their translations.
Git/Github have excellent mechanisms for tracking changes. We recommend that when you add document front matter to your translation with the commit information for the page you translated. This allows anyone to go back later and find out whether the text has changed since it was last translated. For example:
--- translated_page: https://github.com/PX4/Devguide/blob/master/en/setup/config_initial.md translated_sha: 95b39d747851dd01c1fe5d36b24e59ec865e323e translated: false ---
Note The translated_sha is the full SHA of the commit that you translated. Find this by opening the source page on github, press the History button. Find the commit of the document you are translating from (ideally the most recent) and press the "Copy the full SHA" icon associated with that commit.