Cloud Shell에서 튜토리얼 작성

Cloud Shell은 사용자가 신속하고 효과적으로 프로젝트를 익힐 수 있도록 도와주는 튜토리얼을 구축하고 시작하는 작업을 지원합니다.

튜토리얼은 마크다운 방식으로 작성된 일련의 지침입니다. Cloud Shell은 Google Cloud Console의 패널에 표시되는 단계와 하위 단계로 텍스트를 파싱하여 이러한 마크다운 파일을 토대로 컨텍스트 내 튜토리얼을 만듭니다.

튜토리얼 작성하기

튜토리얼은 CommonMark 마크다운으로 작성됩니다. 스포트라이트 강조 기능 및 인라인 아이콘 추가와 같은 고급 기능을 포함하는 지시문과 마찬가지로 마크다운 확장 프로그램이 지원됩니다.

단계

튜토리얼을 만들 때는 구성을 결정하는 머리말이 필요합니다. 정확한 제목, 단계 머리말, 기본 지침을 설정하려면 다음 계층 구조를 사용하세요.

• 튜토리얼 제목에는 H1(#) 태그를 사용합니다. 튜토리얼에는 H1 태그가 하나만 있어야 합니다.
• 단계 제목에는 H2(##) 태그를 사용합니다.
• 하위 단계 제목에는 H3(###) 태그를 사용합니다.

튜토리얼을 만들 때 사용할 수 있는 샘플 마크다운 파일은 다음과 같습니다.

# First tutorial

## First step

Hello world

### Part 1

Part one instructions.

### Part 2

Part two instructions.

## Conclusion

Done!

지시어

지시문은 스포트라이트 강조 기능 및 인라인 아이콘 추가와 같은 고급 기능을 사용 설정합니다.

지시문을 추가하려면 다음 형식을 사용합니다.

<walkthrough-DIRECTIVE_NAME PARAMETER="PARAMETER_VALUE">
</walkthrough-DIRECTIVE_NAME>

예를 들어 editor-open-file 지시문과 filePath 매개변수를 사용하려는 경우 다음과 같이 작성합니다.

<walkthrough-editor-open-file filePath="test/hello.md">
</walkthrough-editor-open-file>

사용 가능한 지시문을 보려면 지시문 참조를 확인하세요.

Cloud Shell에서 튜토리얼 시작하기

Cloud Shell에서 튜토리얼을 시작하는 방법에는 두 가지가 있습니다.

1. cloudshell launch-tutorial 명령어 사용하기

   Cloud Shell 세션에서 다음 cloudshell 명령어를 실행하여 기존 Markdown 파일 tutorial.md에서 튜토리얼을 시작합니다.

   cloudshell launch-tutorial tutorial.md
   

   또는 Cloud Shell 세션에서 다음 명령어를 실행하여 teachme 별칭을 사용해 기존 파일 hello.md에서 튜토리얼을 시작할 수도 있습니다.

   teachme hello.md
   

2. Cloud Shell에서 열기 사용

   또는 웹사이트, 블로그, 오픈소스 프로젝트부터 Git 저장소 호스팅 튜토리얼까지 사용자들을 안내하는 Cloud Shell에서 열기 기능을 사용해도 됩니다. Cloud Shell에서 열기 기능은 URL 끝에 추가하여 저장소에서 소스 마크다운 파일의 위치를 지정할 수 있는 cloudshell_tutorial 매개변수를 허용합니다. 즉, 튜토리얼에 연결된 버튼의 마크다운은 다음과 같아야 합니다.

   [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://ssh.cloud.google.com/cloudshell/open?cloudshell_git_repo=GIT_REPO_URL&cloudshell_tutorial=PATH_TO_MD_FILE)
   

다음 단계

• 튜토리얼별 마크다운 표현식의 전체 목록은 튜토리얼 마크다운 참조를 참조하세요.
• 효과적인 튜토리얼을 작성하는 방법에 대한 가이드라인은 튜토리얼 작성 지침를 참조하세요.