在 Cloud Shell 中创建私有教程

Cloud Shell 支持创建私有教程，使您可以专门为受众群体设计教程。

按照在 Cloud Shell 中编写教程指南编写教程并按照教程样式指南中的最佳实践操作后，您可以：可以在私有 Git 代码库中托管您的教程，以供用户使用。

您可以使用任何偏好的 Git 代码库托管服务。本指南使用 Secure Source Manager（在 Google Cloud上托管的区域级 单租户托管源代码库）来 演示相关步骤。

创建私有 Git 代码库

Secure Source Manager 实例部署到可用 Google Cloud 区域，并且可以通过其实例 URI 进行访问。代码库是在 Secure Source Manager 实例中使用网页界面或 Secure Source Manager API 创建的。

如需创建 Secure Source Manager 代码库以托管您的私有教程，请完成以下步骤。

  1. 启动 Cloud Shell 终端。 对于独立 Cloud Shell 会话，请使用 shell.cloud.google.com。

  2. 创建一个 Secure Source Manager 实例（如果您还没有）：

    gcloud source-manager instances create INSTANCE_ID \
    --region=LOCATION

    替换以下内容：

    • INSTANCE_ID：Secure Source Manager 实例的 ID。
    • LOCATION：您要在其中创建实例的区域，例如 us-central1。

    创建实例最多可能需要 60 分钟。

  3. 如需通过网页界面访问 Secure Source Manager 实例，请将以下网址复制到浏览器地址栏中：

    INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev

    将 PROJECT_NUMBER 替换为实例的 Google Cloud 项目 编号。

  4. 创建私有代码库：

    gcloud source-manager repos create REPO_ID \
    --instance=INSTANCE_ID \
    --region=LOCATION

    将 REPO_ID 替换为 Secure Source Manager 代码库的 ID。

    如需了解创建代码库所需的权限，请参阅 所需角色。

  5. 将 Secure Source Manager 身份验证帮助程序添加到全局 Git 配置。 如需了解详情，请参阅 设置凭据。

  6. 将您的代码库克隆到 Cloud Shell：

    git clone https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

    将 PROJECT_ID 替换为实例的 Google Cloud 项目 ID。

  7. 将教程文件移动到本地创建的代码库：

    mv PATH_TO_TUTORIAL REPO_ID/PATH_TO_TUTORIAL

    将 PATH_TO_TUTORIAL 替换为私有教程的路径。

  8. 转到您的本地代码库：

    cd REPO_ID

  9. 添加、提交和推送教程文件：

    git add .
git commit -m "Add private tutorial to Secure Source Manager"
git push origin main

  10. 您可以在网页界面中查看 Secure Source Manager 代码库。如需了解详情，请参阅 列出和查看代码库。

为了帮助用户访问您的教程，您可以使用 Cloud Shell 的“在 Cloud Shell 中打开”功能，该功能可让您定义用户如何访问教程。如需详细了解如何自定义 链接，请参阅在 Cloud Shell 中打开指南。

对于托管在 Secure Source Manager 代码库中的教程，您需要使用代码库的 HTTPS 网址定义 cloudshell_git_repo 参数。例如：

https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

您可以将此链接设计为按钮，并将其嵌入文档中，以便用户找到。例如：

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git)

使用插件工具自定义教程

通过为用户提供自定义工具来处理您的教程，您可以进一步自定义您的私有教程体验。

为此，您可以创建一个 Docker 映像，将其用作自定义 Cloud Shell 环境，并在其中包含您希望提供给用户的所有其他软件包和自定义配置。