플랫팩 문서

flatpak 문서

이 저장소는 Flatpak 개발자 문서의 주요 소스입니다. docs.Flatpak.org에서 읽을 수 있습니다.

일부 문서는 Flatpak wiki와 flatpak 및 flatpak-builder 매뉴얼 페이지의 일부로도 제공됩니다.

문서는 reStructuredText로 작성되었으며 기여를 환영합니다!

설정 개발

Python 가상 환경을 만듭니다.

 python3 -m venv .venv && 소스 .venv/bin/activate

그런 다음 pip를 사용하여 종속성을 설치합니다.

 pip 설치 -r 요구사항.txt

문서 작성

설정 후 문서를 작성할 수 있습니다.

 -C 문서 HTML 만들기

테스트를 실행합니다.

 make -C 문서 링크 확인

HTTP 서버를 실행하고 인쇄된 링크(localhost:8000)를 따라가면 브라우저에서 문서를 볼 수 있습니다.

 python3 -m http.server -d docs/_build/html

번역 구축

기본적으로 작성되는 문서는 영어로 되어 있습니다. 중국어와 같은 다른 언어로 문서를 작성하려면 다음 명령을 사용할 수 있습니다.

 -C docs html SPHINXOPTS='-D 언어=zh_CN' 만들기

문서 번역

새 언어를 추가하는 풀 요청을 열 수 있습니다.

유지관리자는 다음을 실행하여 템플릿 파일( .pot )을 생성하고, 번역 파일( .po )을 업데이트하고, 사용되지 않는 번역 파일(즉, 일치하는 .pot 파일이 더 이상 존재하지 않음)을 제거할 수 있습니다.

 make -C 문서 업데이트-po

청중

데스크톱 응용 프로그램 개발자는 Flatpak 문서의 주요 독자이며, 특히 Linux가 아닌 플랫폼의 응용 프로그램을 포함한 기존 응용 프로그램의 작성자입니다.

문서는 가능한 한 이 청중 사이에서 널리 사용되는 관행을 반영해야 하며 응용 프로그램이 Linux 데스크톱 공간에서 나온다고 가정해서는 안 됩니다. 실제적인 측면에서 이는 다음을 기대해야 함을 의미합니다.

• 버전 관리를 위한 Git
• 호스팅용 GitHub
• Freedesktop 런타임
• .desktop 파일, AppStream 및 D-Bus와 같은 Linux 데스크톱 규칙에 대한 사전 지식이 없습니다.

이러한 기본 기본값 외에도 Electron 및 Qt와 같은 널리 사용되는 크로스 플랫폼 기술에 특별한 별도의 주의를 기울여야 합니다.

지침

문서에 기여하고 싶은 사람들을 위한 지침:

• 기본 Flatpak 개념 설명
• 표준 애플리케이션 개발자 워크플로우에 집중
• 문서를 사용하여 Flatpak의 이점과 개발자가 이를 사용할 수 있는 이유를 설명하세요.
• 애플리케이션 개발자에게 필수적인 것만 다루십시오. 절대적으로 필요한 경우가 아니면 Flatpak 내부 세부 정보를 포함하지 마십시오.
• 최대한 원활하고 원활한 개발자 경험 제공
• 개발자가 직면할 수 있는 잠재적인 문제를 예측하고 문제를 방지함으로써 어려움을 예방하는 데 도움이 됩니다.