Jandig: 「コンテンツの公開方法」マニュアルを改善する

@discombobulatemeこのドキュメントを見て、いくつかの改善点を提案していただけますか？

これは実際のドキュメントに関連しています。

2020年9月21日月曜日21：54、Matheus Salles Blanco <
[email protected]>は次のように書いています：

この問題は実際のマニュアルドキュメントに関連していますか？ またはに
改善する必要がある公開方法のアプリケーション内チュートリアル？

—
スレッドを作成したため、これを受け取っています。
このメールに直接返信し、GitHubで表示してください
https://github.com/memeLab/Jandig/issues/244#issuecomment-696457035 、または
登録を解除する
https://github.com/notifications/unsubscribe-auth/AAH4ULG6BN72GEWAOFVYY33SG7YT7ANCNFSM4I5SVXAA
。

-
アンジェロピクセル
https://www.linkedin.com/in/vjpixel/

これは実際のドキュメントに関連しています。
…
2020年9月21日月曜日21：54、Matheus Salles Blanco < @ 。 * >書き込み：この問題は実際のマニュアルドキュメントに関連していますか？ または、改善する必要がある公開方法のアプリケーション内チュートリアルに？ —スレッドを作成したため、これを受け取っています。 このメールに直接返信するか、GitHub < ＃244（コメント） >で表示するか、 https：//github.com/notifications/unsubscribe-auth/AAH4ULG6BN72GEWAOFVYY33SG7YT7ANCNFSM4I5SVXAAの登録を解除してください。
--Angelo Pixel https://www.linkedin.com/in/vjpixel/

とった！ どうもありがとうございました！

さらにサポートが必要な場合は、pingを送信してください。

こんにちは、私はこのドキュメントに関するいくつかの疑問をチェックしたいと思いました。

最初はその言語についてです。 私たちはこのマニュアルを英語で書いたので、それが大丈夫かどうか、またはポルトガル語が閲覧ユーザーにとってより適切であるかどうかを知りたいと思います。

第二に、ドキュメント表示フレームワークについてです。 JandigはSphynxを使用してドキュメントをコンパイルおよび表示していると思いますが、正しいですか？ コンピューターでローカルビルドを実行したときに、「ヘルプ」ページにアクセスしようとすると、DJANGOがindex.htmlファイルに関するエラーをスローしました。 これは、開発ブランチとこの特定の問題のために作成されたブランチの両方で発生しました。

ブラウザに表示されるエラーのスクリーンショットは次のとおりです。

そして、私がコードでそれを調べようとしたとき、docsフォルダー内のindex.rstファイルにエラーがありました：

これは予期されるエラーですか？ ヘルプページにアクセスするには、特定の構成が必要ですか？

こんにちはマテウス、

マニュアルを英語で書いたようですね。 より多くの海外ユーザーを惹きつけたいので、それは素晴らしいことです。

ただし、ユーザーの大多数はポルトガル語を話すため、両方のバージョンを保持することをお勧めします。

新しいバージョンをポルトガル語に翻訳することは可能だと思いますか？両方ありますか？

@pablodiegossは私よりもスフィンクスについてよく答えることができます。

こんにちはマテウス、

マニュアルを英語で書いたようですね。 より多くの海外ユーザーを惹きつけたいので、それは素晴らしいことです。

ただし、ユーザーの大多数はポルトガル語を話すため、両方のバージョンを保持することをお勧めします。

新しいバージョンをポルトガル語に翻訳することは可能だと思いますか？両方ありますか？

@pablodiegossは私よりもスフィンクスについてよく答えることができます。

はい、もちろん。 プルリクエストには、翻訳できるように、とりあえずWIPタグを付けておきます。

終わった！ タグをREVIEWに変更しました。

第二に、ドキュメント表示フレームワークについてです。 JandigはSphynxを使用してドキュメントをコンパイルおよび表示していると思いますが、正しいですか？ コンピューターでローカルビルドを実行したときに、「ヘルプ」ページにアクセスしようとすると、DJANGOがindex.htmlファイルに関するエラーをスローしました。 これは、開発ブランチとこの特定の問題のために作成されたブランチの両方で発生しました。

ブラウザに表示されるエラーのスクリーンショットは次のとおりです。

あなたのコメントは正しいです。.rstファイルを使用してドキュメントを記述し、Sphinxを使用してそれらからhtmlファイルを生成します。これらのファイルはdjango-docsによってルーティングされ、「/ docs」を介してリンク可能になります。

このエラーに気付いたのは素晴らしいことですが、更新時にいくつかのフォルダーを移動しましたが、Sphinxは以前に生成したindex.htmlを見つけることができませんでした。 問題を見つけて開発ブランチに修正をプッシュしましたが、このコミットをプルした後もエラーが引き続き発生するかどうかを確認できますか？

そして、私がコードでそれを調べようとしたとき、docsフォルダー内のindex.rstファイルにエラーがありました：

これは予期されるエラーですか？ ヘルプページにアクセスするには、特定の構成が必要ですか？

これは、RST構文を認識できないエディターからの単なるエラーのようです... VScodeを使用しているようですよね？
私はreStructuredText拡張機能を使用して、最初の構文の強調表示と提案を取得しています。おそらく、いくつかの拡張機能をインストールすると、問題が修正されます。

このエラーに気付いたのは素晴らしいことですが、更新時にいくつかのフォルダーを移動しましたが、Sphinxは以前に生成したindex.htmlを見つけることができませんでした。 問題を見つけて開発ブランチに修正をプッシュしましたが、このコミットをプルした後もエラーが引き続き発生するかどうかを確認できますか？

@pablodiegoss私はここで私たちのブランチでテストしました、そしてあなたの最後のコミットは問題を修正しました😄

遅れて申し訳ありません。 ＃330にコメントしました。

こんにちは！ このPRはすでに統合されているので、この問題を解決できますか？

うん！