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

本页面上的说明向您展示了如何使用文本编辑器在本地环境中工作,以创作文档并提交拉取请求(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 Desktop中,commit您的工作,如下所示。

    提交本地

  2. 在GitHub Desktop中, 将您的工作推送到remote分支,如下所示。

    推送您的提交

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

    创建拉取请求

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

    小贴士

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

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

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

  6. 您可以通过检查https://github.com/AdobeDocs/experience-platform.en中的​拉取请求​选项卡,确认已提交拉取请求。

PR成功

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

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

在此页面上