ナレッジベースの更新・変更

AdGuardナレッジベース（知恵袋）の目的は、AdGuard関連のあらゆるトピックに関する最新情報・説明・使い方を皆様に提供することです。 しかし、情報は常に変化し、記事が現状を反映しきれなくなることがあります。

そのため、AdGuardナレッジベースコンテンツをすべてGitHubに置き、既存の記事の編集や翻訳、まったく新しい記事の提案など、誰もが貢献できるようにしています。

変更点を提案する・新しい記事を書く方法

上記のGitHubの機能を使って、既存記事への変更を提案したり、新しい記事をナレッジベースに追加することができます。 GitHubプラットフォームでの作業方法をあまりわからない場合は、こちらのGitHubの使い方に関するドキュメントを確認することから始めてください。

準備ができましたら、KnowledgeBaseリポジトリで作業してください。 ナレッジベースにあるすべてのテキスト・文章は、 Markdownマークアップ言語を使って書かれています。 記事の編集や執筆の際には、このことを念頭に置いてください。 こちらで、Markdownの構文について詳しく知ることができます。

ナレッジベースのウェブサイトは、現代の静的ウェブサイトジェネレータである「Docusaurus 2」を使用して構築されています。 変更または追加を提案する場合、すべてのテキストがのDocusaurus 2に準拠している必要があります。 Docusaurus 2の原則は、 このリンク先のDocusaurusガイドで確認することができます。

このナレッジベースは、お使いのコンピュータでローカルに展開することで、提案する変更をプレビューすることができます。 この方法は、本ナレッジベースのGitHubページにあるREADME.mdファイルに記載されています。

記事を翻訳する方法

ナレッジベースの既存記事の翻訳は、 Crowdin platformを使って行われています。 Crowdinの翻訳と作業に関するすべての詳細は、AdGuard広告ブロッカーのナレッジベースにある専用記事に記載されています。

AdGuardナレッジベースの記事を翻訳する際、複数形を含む文字列に遭遇することがありますが、複数形がいっぱいある言語の場合は特に注意して翻訳してください。 別の記事で、複数形の文字列を翻訳する際に起こりうる困難について詳しく説明し、複数形に関するCrowdinプラットフォームでの作業方法について幅広く解説しています。

Open issue（GitHub）に対する作業・貢献

ナレッジベースの更新に関連するオープンタスクが存在することがあります。 このナレッジベースに対する他の変更を提案するのと同じ方法で、タスクの完了を高速化いただくことができます。 お好みのissueを選んで、ぜひ作業を始めてください。 issueに関してご質問等があれば、お気軽にissueのコメント欄で直接メッセージしてください。