Minecraft Bedrock ドキュメントへの投稿

Minecraft Bedrock ドキュメントの公開リポジトリへようこそ! このリポジトリであなたが作成または編集した記事はすべて、一般に公開されます。

Minecraft Bedrock ドキュメントは、GitHub Flavored Markdown と Markdig 機能を使用している docs.microsoft.com プラットフォーム上にあります。 このリポジトリであなたが編集したコンテンツは、Minecraft Bedrock ドキュメントに表示される Microsoft Docs スタイルに従ったページに書式設定されます。あなたや Bedrock コミュニティーの他のメンバーによって作成されたコンテンツは、Microsoft のコンテンツ ドロップおよび Minecraft: Bedrock Edition のアップデートの一部としてリリースされます。

このページでは、投稿の基本的な手順とガイドラインについて説明し、Markdown の基本へのリンクを示します。 皆さんのご投稿をお待ちしています!

利用可能なリポジトリ

リポジトリ名 URL
Minecraft Bedrock ドキュメント https://github.com/MicrosoftDocs/minecraft-creator

始める前に

まだお持ちでない場合は、GitHub アカウントを作成する必要があります。

また、GitHub アカウントを設定する際には、次のセキュリティ対策をとることをお勧めします。

  • Github アカウント用に強力なパスワードを作成します。
  • 2 要素認証を有効にします。
  • 回復用コードを安全な場所に保存します。
  • パブリック プロフィールの設定を更新します。
    • 自分の名前を設定し、[Public email (パブリック メール)] を [Don't show my email address (自分のメール アドレスを表示しない)] に設定することを検討します。
    • 投稿するドキュメントのページにサムネイルが表示されるので、プロフィール写真をアップロードすることをお勧めします。
  • コマンド ラインの使用を予定している場合は、Git Credential Manager for Windows を設定することを検討します。 これにより、投稿を行うたびにパスワードを入力する必要がなくなります。

公開システムは GitHub に関連付けられているので、これらの手順は重要です。 あなたは自分の GitHub エイリアスを使用して、各記事の作成者または共同作成者として表示されます。

既存の記事の編集

Web ブラウザーで GitHub を使用して既存の記事を更新するには、次のワークフローを使用します。

  1. Minecraft クリエイター ドキュメント内で編集したい記事に移動します。

  2. 右上の編集ボタン (鉛筆のアイコン) を選択すると、自由に使えるブランチが 'main' ブランチから自動的にフォークされます。

学習ポータルの [Edit (編集)] ボタン

  1. 記事のコンテンツを編集し、「Markdown の基本」に従って書式設定します。

  2. 各記事の一番上にあるメタデータを更新します。

    • title: 記事が閲覧されているときにブラウザーのタブに表示されるページ タイトル。 ページ タイトルは SEO とインデックス作成に使用されるので、必要な場合以外はタイトルを変更しないでください (ただしこれは、ドキュメントが公開される前にはあまり重要ではありません)。
    • description: 記事のコンテンツに関する簡単な説明を記述します。これにより SEO と検出が改善されます。
    • author: あなたがページのプライマリ所有者である場合は、自分の GitHub エイリアスをここに追加します。
    • ms.author: あなたがページのプライマリ所有者である場合は、自分の Microsoft エイリアス (@microsoft.com は含めず、エイリアスのみ) をここに追加します。
    • ms.date: ページに重要なコンテンツを追加する場合は、この日付を更新します。ただし、補足説明、書式設定、文法、スペルなどの修正の場合には更新しません。
    • keywords: キーワードは、SEO (検索エンジンの最適化) に役立ちます。 この記事に固有のキーワードをコンマとスペースで区切って追加します。ただし、リスト内の最後のキーワードの後には句読点を付けません。 すべての記事に当てはまる全体的なキーワードを追加する必要はありません (これは別の場所で管理されます)。

  3. 記事の編集が完了したら、下にスクロールして [Propose file change (ファイル変更の提案)] を選択します。

  4. 次のページで、[Create pull request (プル リクエストの作成)] を選択して、自動的に作成された自分のブランチを 'main' にマージします。

  5. 編集する次の記事についても上の手順を繰り返します。

既存の記事の名前変更または削除

既存の記事を名前変更または削除する場合は、必ずリダイレクトを追加してください。 これにより、既存の記事へのリンクを使用している人が引き続き正しいページにアクセスできるようになります。 リダイレクトは、リポジトリのルートにある .openpublishing.redirection.json ファイルによって管理されます。

.openpublishing.redirection.json にリダイレクトを追加するには、次のように redirections 配列にエントリを追加します。

{
    "redirections": [
        {
            "source_path": "minecraft-creator/creator/old-article.md",
            "redirect_url": "new-article#section-about-old-topic",
            "redirect_document_id": false
        },
  • source_path は、削除しようとしている古い記事への相対リポジトリ パスです。 このパスは minecraft-creator/creator で始まり、.md で終わるようにします。
  • redirect_url は、古い記事から新しい記事への相対パブリック URL です。 この URL はリポジトリのパスではなくパブリック URL を指すので、minecraft-creator/creator や .md を含めないようにしてください。 #section を使用して新しい記事内のセクションにリンクすることができます。 必要な場合は、ここで別のサイトへの絶対パスを使用することもできます。
  • redirect_document_id は、前のファイルのドキュメント ID を保持するかどうかを示します。 デフォルトは false です。 リダイレクト元の ms.documentid 属性の値を保持する場合は true を使用します。 ドキュメント ID を保持する場合、ページ ビューやランキングなどのデータがリダイレクト先の記事に転送されます。 これはリダイレクトが主に名前変更を目的とする場合に行い、同じコンテンツを部分的にしか扱っていない別の記事を指す場合には行わないでください。

また、リダイレクトを追加する場合は必ず古いファイルを削除してください。

新しい記事の作成

Web ブラウザーで GitHub を使用してドキュメント リポジトリ内に新しい記事を作成するには、次のワークフローを使用します。

  1. MicrosoftDocs/minecraft-creator の 'main' ブランチからフォークを作成します (右上の [Fork (フォーク)] ボタンを使用します)。

GitHub の [Fork (フォーク)] ボタン

  1. "creator/Documents" フォルダーで、右上の [Add file (ファイルの追加)] > [Create new file (新しいファイルの作成)] を選択します。

  2. この記事のページ名を作成し (スペースではなくハイフンを使用し、句読点やアポストロフィは使用しないでください)、".md" を付加します。

重要

新しい記事の作成は、必ず "creator/Documents" フォルダー内から行います。 これは、新しいファイルの名前の行に "/creator/Documents" が含まれているかどうかを調べることで確認できます。

  1. 新しいページの一番上に、次のメタデータ ブロックを追加します。
---
title:
description:
author:
ms.author:
ms.date:
ms.topic: article
keywords:
---

  1. 上のセクションの指示に従って、関連するメタデータ フィールドに入力します。

  2. Markdown の基本を使用して記事のコンテンツを記述します。

  3. 記事の一番下に、他の関連記事へのリンクを含む ## See also セクションを追加します。

  4. 記事の記述が完了したら、[Commit new file (新しいファイルのコミット)] を選択します。

  5. [New pull request (新しいプル リクエスト)] を選択し、自分のフォークの 'main' ブランチを MicrosoftDocs/minecraft-creator の 'main' ブランチにマージします (矢印が正しい向きになっていることを確認してください)。

GitHub のプル リクエスト

プル リクエストは、Microsoft のコンテンツ チームによって確認されます。 承認された場合は、変更が次の正規リリースで適用されます。 プル リクエストが承認されなかった場合は、コンテンツ チームのメンバーが、承認されなかった理由を知らせるコメントをプル リクエストに残します。

Markdown の基本

Markdown 言語を使用してドキュメントを編集する方法について学ぶには、次のリソースが役立ちます。

テーブルの追加

docs.microsoft.com でのテーブルのスタイル設定方法により、インライン CSS を試みても、テーブルには罫線やカスタム スタイルが適用されません。 少しの間は機能しているように見えますが、最終的にはプラットフォームによってテーブルからスタイル設定が除去されます。 そのため、先を見越してテーブルをシンプルに保ちましょう。 Markdown テーブルを簡単にするサイトを以下に示します。

ドキュメントの編集に Visual Studio Code を使用している場合は、Visual Studio Code 向け Docs Markdown Extension (下記参照) でテーブル生成を簡単にすることもできます。

|Title 1 |Title 2| Title 3|
|--------|-------|--------|
|This will |Show a three |column table|

画像の追加

リポジトリ内の "minecraft-creator/creator/images" フォルダーに画像をアップロードし、記事内でそれを適切に参照する必要があります。 画像は自動的にフルサイズで表示されるので、大きな画像は記事の幅いっぱいに表示されます。 アップロードする前に、あらかじめ画像のサイズを設定しておくことをお勧めします。 推奨される幅は 600 - 700 ピクセルですが、細かいスクリーンショットであればサイズを大きくしたり、スクリーンショットの一部分のみであればサイズを小さくしたりする必要があります。

重要

マージ前の、フォークした自分のリポジトリに対してのみ画像をアップロードできます。 そのため、記事に画像を追加する予定がある場合は、Visual Studio Code を使用して最初に自分のフォークの "images" フォルダーに画像を追加するか、または Web ブラウザーで以下の手順を実行済みであることを確認する必要があります。

  1. MicrosoftDocs/minecraft-creator リポジトリをフォークします。
  2. 自分のフォーク内で記事を編集します。
  3. 記事内で参照する画像を、自分のフォークの "minecraft-creator/creator/images" フォルダーにアップロードします。
  4. 自分のフォークを MicrosoftDocs/minecraft-creator の 'main' ブランチにマージするためのプル リクエストを作成します。

自分でフォークしたリポジトリを設定する方法については、新しい記事の作成に関する指示に従ってください。

作業のプレビュー

Web ブラウザーを使って GitHub で編集しているときに、ページの上部近くにある [Preview (プレビュー)] タブを選択して、コミットする前に作業をプレビューすることができます。

注意

review.docs.microsoft.com での変更のプレビューは、Microsoft の従業員のみが利用できます。

Microsoft の従業員: 自分の投稿が 'main' ブランチにマージされたら、公開される前にそのコンテンツを https://github.com/MicrosoftDocs/minecraft-creator/tree/main/creator でレビューできます。 左側の列にある目次を使用して、記事を探します。

Web ブラウザーでの編集とデスクトップ クライアントでの編集

ブラウザーでの編集は変更をすばやく行うための最も簡単な方法ですが、いくつかの欠点もあります。

  • スペルチェックは行われません。
  • 他の記事へのスマートリンクは表示されません (記事のファイル名を手動で入力する必要があります)。
  • 画像のアップロードと参照に手間がかかる場合があります。

これらの問題を回避したい場合は、Visual Studio Code などのデスクトップ クライアントを、投稿時に役立ついくつかの便利な拡張機能と共に使用します。

Visual Studio Code の使用

上記の理由で、Web ブラウザーではなくデスクトップ クライアントを使用してドキュメントを編集したい場合があります。 Visual Studio Code を使用することをお勧めします。

設定

このリポジトリを操作できるように Visual Studio Code を構成するには、次の手順に従います。

  1. Web ブラウザーで以下を行います。

    a. お使いの PC に対応した Git をインストールします。

    b. Visual Studio Code をインストールします。

    c. まだ行っていない場合は、MicrosoftDocs/minecraft-creator をフォークします。

    d. 自分のフォーク内で、[Clone or download (クローンまたはダウンロード)] を選択し、URL をコピーします。

  2. Visual Studio Code 内で自分のフォークのローカル クローンを作成します。

    a. [表示] メニューから [コマンド パレット] を選択します。

    b. 「Git: Clone」と入力します。

    c. コピーした URL を貼り付けます。

    d. クローンを保存する PC 上の場所を選択します。

    e. ポップアップで [リポジトリを開く] を選択します。

Editing documentation

Visual Studio Code でドキュメントに変更を加えるには、次のワークフローを使用します。

注意

上に示した記事の編集および作成に関するガイダンスと Markdown の編集の基本はすべて、Visual Studio Code を使用するときにも当てはまります。

  1. クローンした自分のフォークを、公式リポジトリと同じ最新の状態にします。

    a. Web ブラウザーで、MicrosoftDocs/minecraft-creator の 'main' 内にある他の共同作成者からの最新の変更を自分のフォークに同期するためのプル リクエストを作成します (矢印が正しい向きになっていることを確認してください)。

    GitHub の同期プル

    b. Visual Studio Code で同期ボタンを選択して、更新したばかりの自分のフォークをローカル クローンに同期します。

    GitHub の同期ボタン

  2. Visual Studio Code を使用して、クローンした自分のリポジトリ内で記事を作成または編集します。

    a. 1 つまたは複数の記事を編集します (必要に応じて “images” フォルダーに画像を追加します)。

    b. [エクスプローラー] で変更を保存します。

    c. [ソース管理] ですべての変更をコミットします (プロンプトが表示されたらコミット メッセージを書き込みます)。

    GitHub の変更のコミット

    d. 同期ボタンを選択して、変更をオリジン (GitHub 上の自分のフォーク) に同期します。

  3. Web ブラウザーで、自分のフォーク内の新しい変更を MicrosoftDocs/minecraft-creator の 'main' に同期するためのプル リクエストを作成します (矢印が正しい向きになっていることを確認してください)。

    GitHub のプル リクエスト

便利な拡張機能

ドキュメントを編集する際には、次の Visual Studio Code の拡張機能が役に立ちます。

  • Visual Studio Code 向け Docs Markdown Extension - Alt+M キーを使用すると、次のようなドキュメント作成オプションのメニューが表示されます。
    • アップロードした画像の検索と参照。
    • リスト、テーブル、ドキュメント固有のコールアウト (たとえば >[!NOTE]) などの書式設定の追加。
    • 内部リンクとブックマーク (ページ内の特定のセクションへのリンク) の検索と参照。
    • 書式設定エラーの強調表示 (エラーにカーソルを合わせると詳細が表示されます)。
  • Code Spell Checker - スペルミスがある単語に下線が表示されます。スペルミスがある単語を右クリックして、変更するか、その単語を辞書に保存します。
  • Last updated on