문서화에 기여

PX4 사용자 가이드에 대한 기여를 매우 환영합니다. 간단한 수정 작업 뿐만 아니라, 철자 및 문법, 새로운 주제 등에서 문서화 작업이 필요합니다.

이 항목에서는 변경 사항을 적용하고 테스트하는 방법을 설명합니다. 마지막에는 기본 스타일 가이드가 있습니다.

TIP

Note You will need a (free) GitHub account to contribute to the guides.

Github의 빠른 변경 사항

Simple changes to existing content can be made by clicking the Edit on GitHub link that appears at the bottom of every page (this opens the page on Github for editing).

기존 페이지를 편집하려면:

1. 해당 페이지를 엽니다.
2. Click the Edit on GitHub link below the page content.
3. 파일을 편집합니다.
4. Below the Github page editor you'll be prompted to create a separate branch and then guided to submit a pull request.

문서 팀은 요청을 검토하고, 병합하거나 업데이트하기 위하여 귀하와 협력할 것입니다.

Git을 사용한 변경(새 페이지 및 이미지)

새 페이지 추가 또는 이미지 추가/수정을 포함하여 보다 실질적인 변경은 Github에서 수행(또는 적절하게 테스트)하는 것처럼 간단하지 않습니다. For these kinds of changes we suggest using the same approach as for code:

1. Use the git toolchain to get the documentation source code onto your local computer.
2. 필요한 문서를 수정합니다(추가, 변경, 삭제).
3. Test that it builds properly using Vitepress.
4. 변경 사항에 대한 분기를 만들고 풀 요청을 만들어 문서로 다시 가져옵니다.

다음에는 소스 코드를 가져오고, 로컬에서 빌드(테스트용)하고, 코드를 수정하는 방법을 설명합니다.

문서 소스 코드 가져오기/보내기

라이브러리 소스를 로컬 컴퓨터로 가져오려면 git 명령어를 사용하여야 합니다. 아래 지침은 git을 가져와 로컬 컴퓨터에서 사용하는 방법을 설명합니다.

1. Download git for your computer from https://git-scm.com/downloads

2. Sign up for Github if you haven't already

3. Create a copy (Fork) of the PX4 User Guide repo on Github (instructions here).

4. 복사된 저장소를 로컬 컴퓨터에 복제합니다.

   cd ~/wherever/
   git clone https://github.com/<your git name>/PX4-user_guide.git

   예를 들어, Github 계정이 "john_citizen"인 사용자의 PX4 사용자 가이드 포크를 복제합니다.

   git clone https://github.com/john_citizen/PX4-user_guide.git

5. 로컬 저장소로 이동합니다.

   cd ~/wherever/PX4-user_guide

6. Add a remote called "upstream" to point to the PX4 version of the library:

   git remote add upstream https://github.com/PX4/PX4-user_guide.git

   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.

:::

7. 변경 사항에 대한 브랜치를 생성합니다.

   git checkout -b <your_feature_branch_name>

   This creates a local branch on your computer named your_feature_branch_name.

8. 필요에 따라 문서를 변경합니다(다음 섹션에서 이에 대한 일반 지침).

9. 변경 사항에 완료되면 "커밋"을 사용하여, 로컬 브랜치에 추가합니다.

   git add <file name>
   git commit -m "<your commit message>"

   For a good commit message, please refer to the Source Code Management section.

10. 로컬 분기(추가된 커밋 포함)를 Github의 분기된 저장소에 푸시합니다.

    git push origin your_feature_branch_name

11. Go to your forked repository on Github in a web browser, e.g.: https://github.com/<your git name>/PX4-user_guide.git. 새 분기가 분기된 저장소로 푸시되었다는 메시지가 표시되어야 합니다.

12. 풀 요청(PR) 생성:

    • On the right hand side of the "new branch message" (see one step before), you should see a green button saying "Compare & Create Pull Request". 클릭합니다.
    • 풀 요청 템플릿이 생성됩니다. 그것은 당신의 커밋을 나열하고 의미 있는 제목(하나의 커밋 PR의 경우 일반적으로 커밋 메시지)과 메시지(어떤 이유에서 수행했는지 설명)를 추가할 수 있습니다(반드시). Check other pull requests for comparison)

13. 완료하였습니다. PX4 사용자 가이드 유지 관리자는 이제 귀하의 기여를 검투한 후에, 통합 여부를 결정합니다. 때때로 변경 사항에 대한 질문을 확인하십시오.

로컬에서 라이브러리 구축

로컬에서 라이브러리를 빌드하여, 변경 사항이 제대로 반영되었는 지를 테스트합니다.

1. Install the Vitepress prerequisites:

   • Nodejs 18+
   • Yarn classic

2. 로컬 저장소로 이동합니다.

   cd ~/wherever/PX4-user_guide

3. 종속성(Vuepress 포함)들을 설치합니다.

   yarn install

4. Preview and serve the library:

   yarn docs:dev

   • Once the development/preview server has built the library (less than a minute for the first time) it will show you the URL you can preview the site on. This will be something like: http://localhost:5173/px4_user_guide/.
   • Stop serving using CTRL+C in the terminal prompt.

5. 다음을 사용하여 라이브러리를 빌드합니다.

   # Ubuntu
   yarn docs:build
   
   # Windows
   yarn docs:buildwin

TIP

Use yarn start to preview changes as you make them (documents are updated and served very quickly). 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.

소스 코드 구조

The guide uses the Vitepress toolchain.

개요:

• 페이지는 마크다운을 사용하여 별도의 파일에 작성됩니다.

  • 문법은 Github 위키에서 사용하는 것과 매우 유사합니다.
  • Vitepress also supports some markdown extensions. We try and avoid using these, except for tips, warning, etc.. This might be revisited - there are some interesting options provided!

• This is a multilingual book:

  • 각 언어의 페이지는 관련 언어 코드의 이름이 지정된 폴더에 저장됩니다(예: 중국어의 경우 "zh", 한국어의 경우 "ko").
  • Only edit the ENGLISH (/en) version of files. We use Crowdin to manage the translations.

• All pages must be in an appropriately named sub-folder of /en (e.g. this page is in folder en/contribute/).

  • 이렇게 하면 다른 페이지와 이미지가 항상 동일한 상대 수준이므로 연결이 더 용이해집니다.

• The structure of the book is defined in SUMMARY.md.

  • If you add a new page to the guide you must also add an entry to this file!

    TIP

    This is not "standard vitepress" way to define the sidebar (the summary file is imported by .vitepress/get_sidebar.js).

:::

• Images must be stored in a sub folder of /assets. 이것은 콘텐츠 폴더에서 두 개의 폴더 아래에 있으므로, 이미지를 추가하면 다음과 같이 참조하게 됩니다.

  ![Image Description](../../assets/path_to_file/filename.jpg)

• A file named package.json defines any dependencies of the build.

• 웹 후크는 파일이 이 저장소의 마스터 분기에 병합되어, 책이 다시 빌드될 때마다 추적하는 데 사용됩니다.

새 페이지 추가

When you add a new page you must also add it to en/SUMMARY.md!

스타일 가이드

1. 파일/파일명

   • Put new markdown files in an appropriate sub-folder of /en/, such as /en/contribute/. 폴더를 중첩하지 마십시오.
   • Put new image files in an appropriate nested sub-folder of /assets/. Deeper nesting is allowed/encouraged.
   • Use descriptive names for folders and files. In particular, image filenames should describe what they contain (don't name as "image1.png")
   • Use lower case filenames and separate words using underscores (_).

2. 이미지

   • 이미지는 최대한 가장 작은 크기와 가장 낮은 해상도를 사용합니다(이렇게 하면 대역폭이 좋지 않은 사용자의 다운로드 비용이 줄어듭니다).
   • New images should be created in a sub-folder of /assets/ (so they can be shared between translations).
   • SVG files are preferred for diagrams. PNG files are preferred over JPG for screenshots.

3. 내용

   • Use "style" (bold, emphasis, etc.) consistently and sparingly (as little as possible).
     • Bold for button presses and menu definitions.
     • Emphasis for tool names such as QGroundControl or prettier.
     • code for file paths, and code, parameter names that aren't linked, using tools in a command line, such as prettier.
   • Headings and page titles should use "First Letter Capitalisation".
   • The page title should be a first level heading (#). All other headings should be h2 (##) or lower.
   • 제목에는 스타일을 추가하지 마십시오.
   • Don't translate the text indicating the name of an info, tip or warning declaration (e.g. ::: tip) as this precise text is required to render the aside properly.
   • Break lines on sentences by preference. Don't break lines based on some arbitrary line length.
   • Format using prettier (VSCode is a has extensions can be used for this).

4. Videos:

   • Youtube videos can be added using the format <lite-youtube videoid="<youtube-video-id>" title="your title"/> (supported via the https://www.npmjs.com/package/lite-youtube-embed custom element, which has other parameters you can pass).
     • Use instructional videos sparingly as they date badly, and are hard to maintain.
     • Cool videos of airframes in flight are always welcome.

어디에서 변경 사항을 추가합니까?

Add new files in folders that cover similar topics. Then reference them in the sidebar (/en/SUMMARY.md) in line with the existing structure!

번역

For information about translation see: Translation.

라이센스

All PX4/Dronecode documentation is free to use and modify under terms of the permissive CC BY 4.0 license.