在本地环境中使用文本编辑器创建目标文档页面

上次更新: 2023-11-01
  • 创建对象:
  • Developer
    User
    Admin
    Leader

此页面上的说明向您展示了如何使用文本编辑器在本地环境中创作文档并提交拉取请求(PR)。 在执行以下指示的步骤之前,请确保已阅读 在Adobe Experience Platform目标中记录您的目标.

连接到GitHub并设置本地创作环境

  1. 在浏览器中,导航到 https://github.com/AdobeDocs/experience-platform.en

  2. 分支 存储库中,单击 分支 如下所示。 这会在您自己的GitHub帐户中创建Experience Platform存储库的副本。

    创建分支Adobe文档存储库

  3. 将存储库克隆到您的本地计算机. 选择 “代码”>“HTTPS”>“使用GitHub Desktop打开”,如下所示。 确保您拥有 GitHub Desktop 已安装。 有关详细信息,请阅读 创建存储库的本地克隆 在Adobe参与者指南中。

    将Adobe文档存储库克隆到本地环境

  4. 在本地文件结构中,导航到 experience-platform.en/help/destinations/catalog/[...],其中 [...] 是您目标的所需类别。 例如,如果要向Experience Platform添加个性化目标,请选择 personalization 文件夹。

为您的目标创作文档页面

  1. 您的文档页面基于 自助服务目标模板. 下载 目标模板. 解压缩并解压缩文件 yourdestination-template.md 到上述步骤4中提到的目录。 重命名文件 YOURDESTINATION.md,其中YOURDESTINATION是您在Adobe Experience Platform中的目标的名称。 例如,如果公司名为Moviestar ,则应该命名您的文件 moviestar.md.
  2. 在“ ”中打开新文件 选择的文本编辑器. Adobe建议您使用 Visual Studio代码 并安装AdobeMarkdown创作扩展。 要安装该扩展,请打开Visual Studio代码,选择 Extensions 选项卡,并搜索 adobe markdown authoring. 选择扩展并单击 Install.
    安装AdobeMarkdown创作扩展
  3. 编辑模板,其中包含与您的目标相关的信息。 按照模板中的说明操作。
  4. 有关您计划添加到文档的任何屏幕截图或图像,请转到 GitHub/experience-platform.en/help/destinations/assets/catalog/[...],其中 [...] 是您目标的所需类别。 例如,如果要向Experience Platform添加个性化目标,请选择 personalization 文件夹。 为目标创建新文件夹,并将图像保存在此处。 您必须从正在创作的页面中链接到它们。 请参阅 说明如何链接到图像.
  5. 准备就绪后,保存您正在处理的文件。

提交文档以供审阅

小贴士

请注意,此处没有任何可破坏的内容。 按照本节中的说明,您只是建议更新文档。 您建议的更新将由Adobe Experience Platform文档团队批准或编辑。

  1. 在GitHub Desktop中,为您的更新创建一个工作分支,然后选择 发布分支 将分支发布到GitHub。

新建本地分支

  1. 在GitHub桌面中, 提交 您的工作,如下所示。

    提交本地

  2. 在GitHub桌面中, 推送 您的工作到 远程 分支,如下所示。

    推送您的承诺

  3. 在GitHub Web界面中,打开拉取请求(PR),将您的工作分支合并到Adobe文档存储库的主分支中。 确保已选中您处理的分支并选择 Contribute >打开提取请求.

    创建拉取请求

  4. 确保基础分支和比较分支正确。 向PR添加注释,描述您的更新,然后选择 创建拉取请求. 这将打开一个PR,以将分支的工作分支合并到Adobe存储库的主分支。

    小贴士

    离开 允许维护者编辑 复选框,以便Adobe文档团队可以对PR进行编辑。

    创建拉取请求以Adobe文档存储库

  5. 此时,将显示一条通知,提示您签署Adobe参与者许可协议(CLA)。 这是强制步骤。 签署CLA后,刷新PR页面并提交拉取请求。

  6. 您可以通过检查 拉取请求 tab in https://github.com/AdobeDocs/experience-platform.en.

PR成功

  1. 谢谢!如果需要编辑,Adobe文档团队将在PR中联系,并告知您文档何时发布。
小贴士

若要在文档中添加图像和链接,以及询问有关Markdown的任何其他问题,请阅读 使用Markdown 在Adobe的协作编写指南中。

在此页面上