ドキュメントへの貢献機会

貢献 サイトフィードバック
,
1

Discourseのドキュメントは、管理者、モデレーター、ユーザー、システム管理者がDiscourseの使用方法やサイト管理に関するヘルプを見つけるための主要な場所です。

このドキュメントは充実しており多くの分野をカバーしていますが、まだ文書化されていない領域もいくつかあります。これは、コミュニティが参加してDiscourseプロジェクトの重要な部分を洗練させるのに役立つ素晴らしい機会です。

Discourseのドキュメントコンテンツの作成に多くの人が参加してほしいと考えており、誰もがそれを行うことを可能にするためにできるだけ簡単にしたいと考えています。そのために、以下に、新しいまたは改善されたドキュメントの作成が必要であると特定したDiscourseの機能やユースケースのリストを示します。

:notebook_with_decorative_cover: ドキュメントの場所

信頼レベル2以上の誰でも#wikiに新しいドキュメントトピックを作成できます。これは、コミュニティが貢献したすべてのドキュメントコンテンツの拠点です。コミュニティwikiのトピックが関連性があるまたは重要であると見なされた場合、それは#documentationに移動される可能性があります。これは、すべての公式Discourseドキュメントの拠点です。それについての詳細については、ドキュメントポリシーをお読みください。

:gift: ドキュメント貢献者へのバッジ

#wikiカテゴリに新しいトピックを作成した人は、自動的にブロンズのScribeバッジが割り当てられます：

Scribeバッジ
Scribeバッジ714×284 10 KB

そのトピックが公式の#documentationカテゴリに移動するのに十分な価値があると見なされた場合、Discourseチームの誰かがこれを手動で行い、トピックコンテンツに元の著者をクレジットし、彼らにシルバーのGhostwriterバッジを割り当てます：

Ghostwriterバッジ
Ghostwriterバッジ714×330 17.6 KB

:eyes: 書かれる必要があるドキュメント

最終的にはDiscourseのすべての部分を徹底的に文書化したいと考えていますが、これらは私たちが最も緊急性のあるニーズを特定した領域です（取り消し線の項目は、この投稿が最初に公開されてから書かれたトピックを示します）：

  • 管理者向けの一般的な入門チュートリアル
  • カスタムトピックリダイレクト
  • 異なるユーザーレベルが何ができるかの説明
  • ソーシャルログインオプション
  • 投稿通知（公式ドキュメント）
  • 信頼レベルの仕組みに関するより多くのドキュメント
  • Discourseへの良い機能リクエストの書き方（wikiトピック）
  • Discourseのマークダウンおよびフォーマット機能がメールに含まれたときにどのように見えるかに関するリファレンス
  • ユーザーステータス（wikiトピック）
  • ダークモードの説明、選択方法、および切り替えの有効化方法（wikiトピック）
  • ユーザー設定の管理をカバーする一般的なドキュメント（wikiトピック）
  • カテゴリと階層がDiscourseでどのように機能するかを説明するドキュメント
  • トピック設定の一般的なガイド
  • プラグインに関する一般的なガイド - それらが何であるか、どのように機能するか、そしてそれらを使用する方法
  • カスタムホームページ
  • デフォルトのカテゴリとトピックの変更
  • 投稿での画像グリッドの使用（wikiトピック）
  • 投稿承認設定（wikiトピック）

これらの一部は、効果的に文書化するために複数のトピックを必要とする場合があります。

:pencil2: ドキュメントの書き方

Discourseのドキュメントをできるだけ効果的にするために、私たちはこのコンテンツの書き方に関するスタイルガイドを持っています。すべての人がガイドに従うことが役立つだろうが、あなたが#wikiに貢献している場合、完全にそれに固執しないことは問題ではありません。#documentationに移動されたすべてのトピックは、必要に応じてスタイルガイドに一致するようにDiscourseスタッフによって更新されます。

:bulb: 興味がありますか？

#wikiに入って、今日からドキュメントを作成を始めましょう。これらについて議論したい場合は、このトピックに返信してそれについて話すことをお気軽にお申し付けください。

「いいね！」 12
Invisible way to force display order of tags?
8

既存のトピックについてはどうですか？例えば、

「いいね！」 4
9

For this one:

The existing documentation talks about how to request new features, but not how to format a good request to make it more effective. We currently link to this page, but it would be good if we could have that kind of content on Meta instead.

And for this one:

Good catch! I’ll remove that from the list in this topic :slight_smile:

これについては：

既存のドキュメントには新機能のリクエスト方法が記載されていますが、効果的なリクエストを作成するためのフォーマットについては記載されていません。現在、このページをリンクしていますが、代わりにメタにそのようなコンテンツがあると良いでしょう。

そして、これについては：

良い指摘ですね！このトピックのリストから削除します :slight_smile:

「いいね！」 3
10

すでに機能リクエストをカバーするこのトピックがあります

それとも、機能リクエストのためにこのように見える必要があるのでしょうか？ :point_down: :eyes:

「いいね！」 4
11

これはスタッフ通知、それとも何か別の意味ですか？

「いいね！」 1
12

これはタイトルにあるように、投稿通知だと思われます。

スタッフ通知も基本的に同じようなものだと思いますか？

「いいね！」 3
13

はい、それが探しているものです :slight_smile:

@ondrej がリンクしたように、投稿通知はこの告知で概説されているものです。その告知トピックはありますが、それに関する実際のドキュメントはありません。

「いいね！」 4
16

ヒュー、素晴らしいアイデアですね。

コミュニティウィキに、フォーラムテンプレートのようなものにタグを付けるというアイデアを提示したいと思っていました。

このアイデアはこうです。Discourseをサポートフォーラム、学習プラットフォームなどに使用する方法について質問する人がよくいます。時には、テーブルトップRPGのような、よりマイナーな用途もあります。

そのようなトピックからのコンテンツを集め、さまざまな用途を考えることで、マスターとなるトピックをインデックスとして使用する新しいリソースを作成できます。

  • サポートフォーラムテンプレート
  • 学習プラットフォームテンプレート

これらのトピックは、Discourse、Communique（？）などでホストされ、推奨されるプラグインやテーマコンポーネントなどを収容できます。また、セルフホスト用の投稿もあります。

ホスト型テンプレートは、プラグインに焦点を当て、特定のプラグインの使用に必要なプランを参照します。

ヒントやコツを提供し、カスタムレイアウトやプラグインなどが必要な場合は、Marketplace に誘導することもできます。

「いいね！」 3
18

作成しました：

「いいね！」 7
19

それを見ました :smile: これらが届くのを見るのは素晴らしいことです！

「いいね！」 8
21

ダークモードの作業中です。

「いいね！」 5
22

これらのガイドはすでに作成されていますが、まだチェックされていません。

これは少し曖昧です。カスタムホームページのコンテンツを指していますか？もしそうなら、おそらく https://meta.discourse.org/t/add-custom-content-that-only-appears-on-your-homepage/131415。そうでなければ、まだ書かれていません。

「いいね！」 2
23

ここに戻ってきてくれてありがとう。OPをこれらのリンクで更新しました。

これはかなりニッチなもので、カスタムホームページの作成を指しているため、ほとんどのDiscourse管理者があまり使用しないものです。現時点では完全に洗練されたものではないため、主要な機能ではありません。

「いいね！」 2