Cloud Shell のチュートリアル

Cloud Shell は、ユーザーがプロジェクトに迅速かつ効果的に慣れるためのチュートリアルの作成と起動に対応しています。

チュートリアルは、Markdown で記述された一連の手順です。Cloud Shell では、Markdown ファイルのテキストを解析してステップとサブステップを作成することによってコンテキスト内のチュートリアルが作成され、Google Cloud Console の右側のパネルに表示されます。

実行中のチュートリアル

チュートリアルについて学ぶ

このページで説明されている機能について対話形式で学習するには、下のボタンを使用して、チュートリアルの作成についてのチュートリアルを起動します。

Cloud Shell で開く

チュートリアルの作成

チュートリアルは Markdown で作成されます。具体的には HTML ではなく CommonMark 形式で、テキスト エディタを使用して作成できます。チュートリアルをわかりやすくするために、スポットライトやインライン アイコンの追加などの高度な機能が含まれるディレクティブを、チュートリアルの Markdown とともにチュートリアルに追加することもできます。ディレクティブを追加するには、次のカスタム要素形式を使用します。

<walkthrough-directive-name param="optional parameter">
</walkthrough-directive-name>

ステップを作成する

チュートリアルを作成するとき、見出しはその構造を決定するうえで重要です。適切なタイトル、ステップの見出し、および基本的な指示を設定するには、以下の階層に従います。

  • チュートリアルのタイトルの H1(#)タグ。チュートリアルの H1 タグは 1 つだけにする必要があります。
  • ステップのタイトルの H2(##)タグ。
  • サブステップのタイトルの H3(###)タグ。

以下は、チュートリアルの作成に使用できる Markdown ファイルの例です。

# First Tutorial

## First step

Hello World

### Part 1

Part One Instructions.

### Part 2

Part Two Instructions.

## Conclusion

Done!

コードブロックを追加する

コード スニペットをコールアウトするには、次のようにバックティックを使用します。

```
print("hello world")
```

コールアウトされたコード スニペットには、右端にクリップボードへのコピーボタンがあります。

スポットライトを作成する

スポットライトは、ユーザーが Cloud Console の特定の UI 要素を見つけるのに役立つ視覚的な焦点です。

Cloud Console の要素にスポットライトを当てるには、次の形式を使用します。

<walkthrough-spotlight-pointer spotlightId="target" text="label text">
</walkthrough-spotlight-pointer>

Cloud Shell のウェブ プレビュー ウィンドウを開くボタンにスポットライトを当てる場合は、次の形式を使用します。

<walkthrough-spotlight-pointer spotlightId="devshell-web-preview-button"
                               text="Open Cloud Shell">
</walkthrough-spotlight-pointer>

使用できるスポットライト ターゲットのリストは次のとおりです。

Cloud Console のスポットライト ターゲット 説明
devshell-activate-button 右上にある Cloud Shell を開くボタン。
devshell-web-editor-button Cloud Shell のトップバーにある Orion エディタを開きます。
devshell-web-preview-button Cloud Shell のウェブ プレビュー ウィンドウを開きます。

Cloud Shell Editor 要素にスポットライトを当てるには、次の形式を使用します。

<walkthrough-editor-spotlight spotlightId="target" text="label text">
</walkthrough-editor-spotlight>

上記の形式を使用して次のコマンドを実行し、ユーザーが [My file] をクリックしたときに、エディタのスポットライトで既存の hello.md ファイルにスポットライトを当てることができます。

<walkthrough-editor-spotlight spotlightId="navigator" filePath="hello.md"
                              text="My file">
</walkthrough-editor-spotlight>

サポートされている他のエディタのスポットライト ターゲットは次のとおりです。

エディタのスポットライト ターゲット 説明
fileMenu [File] メニューボタンをハイライト表示します。
editMenu [Edit] メニューボタンをハイライト表示します。
navigator [Item] フィールドで指定されたファイルを強調表示します。

インライン アイコンを使用する

Cloud Console ボタンの使用を効率的にコールアウトするには、インライン アイコンを使用します。

使用できるアイコンは次のとおりです。

ディレクティブ 説明
`walkthrough cloud-shell-icon` Cloud Shell アイコン
`walkthrough web-preview-icon` ウェブ プレビュー アイコン
`walkthrough cloud-shell-editor-icon` Cloud Shell エディタ アイコン

ファイル アクションをトリガーする

また、チュートリアルに、ユーザーにとって役立つファイルを開くためのリンクを設定することもできます。ユーザーがチュートリアルを実行し、表示テキスト [Open sample file] をクリックして Cloud Editor でファイルを開くには、次のディレクティブを使用します。

<walkthrough-editor-open-file filePath="path/to/test.md"
                              text="Open sample file">
</walkthrough-editor-open-file>

このファイルはユーザーの Cloud Shell インスタンスに存在している必要があり、指定されるパスは相対ファイルパスである必要があります。このファイルは、ホーム ディレクトリまたはホーム ディレクトリのサブディレクトリのいずれかに配置する必要があります。

Cloud Shell でチュートリアルを起動

Cloud Shell でチュートリアルを起動する方法は 3 つあります。

  1. teachme コマンドを使用する

    Cloud Shell セッションで次のコマンドを実行して、既存のファイル hello.md からチュートリアルを起動します。

    teachme hello.md
    
  2. 「Open in Cloud Shell」を使用する

    また、「Open in Cloud Shell」機能を使用して、ウェブサイト、ブログ、またはオープンソース プロジェクトからチュートリアルへとユーザーを誘導することもできます。「Open in Cloud Shell」機能では、「tutorial」パラメータを使用でき、&tutorial=path/to/file.md のように URL の最後に追加できます。チュートリアルにリンクされているボタンの Markdown は次のようになります。

    [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/testuser/myproject&tutorial=resources/hello.md)
    
  3. cloudshell launch-tutorial コマンドを使用する

    Cloud Shell セッションで次の cloudshell コマンドを実行して、既存の Markdown ファイル tutorial.md からチュートリアルを起動します。

    cloudshell launch-tutorial tutorial.md
    

次のステップ

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...