すべてのプロダクト
Search
ドキュメントセンター

Cloud Shell:チュートリアルの作成

最終更新日:Jan 16, 2025

Cloud Shell でチュートリアルを作成し、リモート Git リポジトリに公開できます。ユーザーはチュートリアルを読んで、プロジェクトを開始できます。

Cloud Shell のチュートリアルモードでは、ユーザーはドキュメント内のコマンドラインをクリックして、Cloud Shell でコマンドラインを実行できます。

ステップ 1:チュートリアルファイルを作成する

チュートリアルファイルを作成するには、次の手順を実行します。

  1. チュートリアルファイルを保存するためのフォルダーを Cloud Shell に作成します。

    mkdir tutorials
  2. フォルダーのルートディレクトリに Markdown ファイルを作成します。たとえば、次のコマンドを実行して tutorial.md ファイルを作成します。

    touch tutorial.md

ステップ 2:チュートリアルを作成する

Markdown 構文を使用してチュートリアルを作成できます。チュートリアルを作成する際には、次の規則に注意してください。

  • シャープ記号(#)を使用してレベル 1 の見出しを作成します。レベル 1 の見出しはチュートリアルのタイトルです。チュートリアルにはレベル 1 の見出しを 1 つだけ作成できます。

  • 2 つのシャープ記号(##)を使用してレベル 2 の見出しを作成します。レベル 2 の見出しはステップのタイトルです。

  • Markdown 構文を使用してコードを作成します。Cloud Shell は、コードをチュートリアル内の [実行] アイコンを持つコードブロックにレンダリングします。ユーザーはコードブロックの [実行] アイコンをクリックして、コードブロックを Cloud Shell のエディターにコピーできます。

    ```bash
    aliyun help
    ```    
  • Cloud Shell の次のディレクトリ命令を使用して、チュートリアルのディレクトリ構造を生成します。

    <tutorial-nav></tutorial-nav>
  • Cloud Shell の次のファイルを開く命令を使用して、チュートリアルにファイルリンクを追加します。ユーザーはチュートリアル内のリンクをクリックして、リンクが Cloud Shell のエディターで指しているファイルを開くことができます。

    <tutorial-editor-open-filefilePath="path/test.md>Open File</tutorial-editor-open-file>

    チュートリアルにファイルのリンクを追加するには、ファイルを $HOME ディレクトリまたは $HOME のサブディレクトリに保存します。命令の filePath をファイルの絶対パスまたは相対パスに設定できます。相対パスは、$HOME を基準としたファイルの場所を指定します。

次のサンプルコードは、チュートリアルを作成する方法の例を示しています。Vim エディターまたは Cloud Shell のエディターを使用してチュートリアルを作成できます。

# Alibaba Cloud CLI を使用してクラウド リソースを管理する

## Alibaba Cloud CLI のヘルプ情報を表示する
```bash
aliyun help
```
### 最初に
メモ
### 次に
メモ
```bash
echo world
```
## チュートリアルが完了しました!
Alibaba Cloud CLI の使用方法に関するチュートリアルが完了しました!

ステップ 3:チュートリアルを公開する

チュートリアルを公開するには、次の手順を実行します。

  1. チュートリアルを公開する前に、次のコマンドを実行してチュートリアルをテストします。

    teachme tutorial.md
  2. チュートリアルがテストに合格したら、Cloud Shell の git push コマンドを実行して、チュートリアルをオンプレミス Git リポジトリからリモート Git リポジトリにアップロードします。チュートリアルを保存するフォルダーは、オンプレミス Git リポジトリです。

    説明

    インターネット経由でアクセスできるリモート リポジトリにチュートリアルをアップロードします。そうしないと、チュートリアルを読むユーザーがリモート リポジトリを Cloud Shell にクローンできない場合があります。