トレーニング
モジュール
ブラウザーで Microsoft Learn ドキュメントに投稿する - Training
GitHub の Web エディターを使用して編集を行うことで、Microsoft Learn ドキュメントの共同作成者になります。 変更を行った後に pull request の作成、検証、提出を行い、変更内容を公開します。
このブラウザーはサポートされなくなりました。
Microsoft Edge にアップグレードすると、最新の機能、セキュリティ更新プログラム、およびテクニカル サポートを利用できます。
HoloLens ドキュメントへようこそ。 このリポジトリで作成または編集した記事 は、一般に公開されます。
HoloLens ドキュメントは、GitHub フレーバーの Markdown と Markdig 機能を使用する Microsoft Learn に公開されています。 このリポジトリで編集したコンテンツは、/hololens
に表示されるスタイル設定されたページに書式設定されます。
このページでは、投稿の基本的な手順とガイドライン、および Markdown の基本へのリンクについて説明します。 あなたの貢献に感謝!
リポジトリ名 | URL |
---|---|
HoloLens | MicrosoftDocs/HoloLens |
Mixed Reality | MicrosoftDocs/Mixed-Reality |
VR 愛好家ガイド | MicrosoftDocs/mixed-reality/enthusiast-guide |
まだお持ちでない場合は、GitHub アカウント
注意
Microsoft の従業員の場合は、Microsoft オープン ソース ポータル
GitHub アカウントを設定する場合は、次のセキュリティ対策もお勧めします。
発行システムは GitHub に関連付けられているため、これらの手順は重要です。 GitHub エイリアスを使用して、各記事の作成者または共同作成者として一覧表示されます。
次のワークフローを使用して、Web ブラウザーで GitHub 経由で 既存の記事を
"hololens" フォルダーで編集する記事に移動します。
右上にある編集ボタン (鉛筆アイコン) を選択します。
これにより、メインの
Markdown の基本に従って記事の内容を編集します。
各記事の上部にあるメタデータを更新します。
記事の編集が完了したら、下にスクロールし、[ファイルの変更
次のページ
編集する次の記事について、上記の手順を繰り返します。
変更によって既存の記事の名前が変更または削除される場合は、必ずリダイレクトを追加してください。 そうすることで、既存の記事へのリンクを持つすべてのユーザーは、引き続き適切な場所に表示されます。 リダイレクトは、リポジトリのルートにある .openpublishing.redirection.json ファイルによって管理されます。
.openpublishing.redirection.jsonへのリダイレクトを追加するには、redirections
配列にエントリを追加します。
{
"redirections": [
{
"source_path": "hololens/old-article",
"redirect_url": "/base-url/new-article#section-about-old-topic",
"redirect_document_id": false
},
source_path
は、削除する古いアーティクルへの相対リポジトリ パスです。 パスがドキュメントセット (この場合は hololens
) で始まり、.md
ファイル拡張子が含まれていることを確認してください。
redirect_url
は、古い記事から新しい記事への相対パブリック URL です。 この URL には .md
含まれていないことを確認し、リポジトリ パスではなくパブリック URL を参照するため、/
で始まります。
#section
を使用して、新しい記事内のセクションへのリンクを許可します。 必要に応じて、別のサイトへの絶対パスを使用することもできます。
redirect_document_id
は、前のファイルのドキュメント ID を保持するかどうかを示します。 既定値は false
です。 リダイレクトされた記事の ms.documentid
属性値を保持する場合は、true
を使用します。 ドキュメント ID を保持すると、ページ ビューやランキングなどのデータがターゲットアーティクルに転送されます。 リダイレクトが主に名前変更であり、同じコンテンツの一部のみをカバーする別の記事へのポインターではない場合は、これを行います。
リダイレクトを追加する場合は、必ず古いファイルも削除してください。
次のワークフローを使用して、Web ブラウザーの GitHub を使用してドキュメント リポジトリに 新しい記事を作成
右上にある
[hololens] フォルダーで、右上 [新しいファイル の作成] を選択します。
記事のページ名を作成し (スペースの代わりにハイフンを使用し、句読点やアポストロフィを使用しない)、".md" を追加します。
重要
"hololens" フォルダー内から新しい記事を作成してください。 これを確認するには、新しいファイル名の行で "/hololens/" を確認します。
新しいページの上部に、次のメタデータ ブロックを追加します。
---
title:
description:
author:
ms.author:
ms.date:
ms.topic: article
keywords:
---
既存の記事を編集するで前述したように、関連するメタデータ フィールド
Markdown の基本
記事の下部に ## See also
セクションを追加し、関連するその他の記事へのリンクを追加します。
完了したら、[新しいファイル コミット]を選択します。
[新しい pull request
Markdown 言語を使用してドキュメントを編集する方法については、次のリソースを参照してください。
Microsoft Learn でテーブルのスタイルを設定する方法により、インライン CSS を試しても、罫線やカスタム スタイルはありません。 短時間は機能するように見えますが、最終的にはプラットフォームによって、テーブルからスタイルが削除されます。 そのため、事前に計画を立て、テーブルをシンプルに保ちます。 Markdown テーブルを簡単にするサイトを次に示します。[Tables Generator]](https://www.tablesgenerator.com/markdown_tables)。
Docs Markdown Extension for Visual Studio Code を使用すると、ドキュメントを編集 Visual Studio Code (下記参照) を使用している場合でも、テーブルの生成が簡単になります。
リポジトリの "hololens/images" フォルダーに画像をアップロードし、記事で適切に参照する必要があります。 画像は自動的にフルサイズで表示されます。つまり、大きな画像は記事の幅全体を埋めます。 画像をアップロードする前に、事前にサイズを設定することをお勧めします。 推奨される幅は 600 ~ 700 ピクセルですが、それぞれ高密度のスクリーンショットまたはスクリーンショットの一部である場合は、サイズを上下に設定する必要があります。
重要
マージする前に、フォークしたリポジトリにのみイメージをアップロードできます。 そのため、記事に画像を追加する予定がある場合は、まず Visual Studio Code を使用して、フォークの "images" フォルダーに画像を追加するか、Web ブラウザーで次の作業を行っていることを確認
独自のフォークされたリポジトリを設定する方法については、新しい記事を作成
Web ブラウザーを使用して GitHub で編集しているときに、ページの上部付近にある [プレビュー] タブを選択して、コミットする前に作業をプレビューできます。
注意
Microsoft Learn での変更のプレビューは、Microsoft の従業員のみが利用できます。
Microsoft の従業員: 投稿が既定のブランチ (メイン
ブラウザーでの編集は、簡単な変更を行う最も簡単な方法ですが、いくつかの欠点があります。
これらの問題に対処しない場合は、
上記の
このリポジトリを操作するように Visual Studio Code を構成するには、次の手順に従います。
Visual Studio Code でドキュメントを変更するには、次のワークフローを使用します。
注意
記事の
複製したフォークが公式リポジトリで最新であることを確認します。
Web ブラウザーで、メイン
Visual Studio Code で、同期ボタンを選択して、更新されたフォークをローカル複製に同期します。
Visual Studio Code を使用して、複製したリポジトリで記事を作成または編集します。
1 つ以上の記事を編集します (必要に応じて、画像を "images" フォルダーに追加します)。
エクスプローラー で [すべて保存] を選択
で [すべてコミット] を選択します
[同期] ボタンを選択して、変更内容を元の元 (GitHub のフォーク) に同期します。
Web ブラウザーで、フォークの新しい変更を MicrosoftDocs/hololens メイン に同期するプル要求を作成します (矢印が正しい宛先を指していることを確認してください)。
次の Visual Studio Code 拡張機能は、ドキュメントを編集するときに役立ちます。
Docs Markdown Extension for Visual Studio Code - Alt + M を使用して、次のような Microsoft Learn オーサリング オプションのメニューを表示します。
>[!NOTE]
などのコールアウトなどの書式設定を追加します。コードスペルチェッカー - スペルミスの単語に下線が引きます。スペルミスのある単語を右クリックして変更するか、辞書に保存します。
トレーニング
モジュール
ブラウザーで Microsoft Learn ドキュメントに投稿する - Training
GitHub の Web エディターを使用して編集を行うことで、Microsoft Learn ドキュメントの共同作成者になります。 変更を行った後に pull request の作成、検証、提出を行い、変更内容を公開します。