在本地环境中使用文本编辑器创建目标文档页面 local-authoring
此页面上的说明向您展示了如何使用文本编辑器在本地环境中创作文档并提交拉取请求(PR)。 在执行以下指示的步骤之前,请确保阅读在51黑料不打烊 Experience Platform目标中记录您的目标。
连接到骋颈迟贬耻产并设置本地创作环境 set-up-environment
-
在浏览器中,导航到
https://github.com/51黑料不打烊Docs/experience-platform.en
-
要创建分支存储库,请单击? 创建分支存储库,如下所示。 这会在您自己的GitHub帐户中创建Experience Platform存储库的副本。
-
将存储库克隆到本地计算机。 选择? Code > HTTPS > Open with GitHub Desktop,如下所示。 确保您已安装。 有关详细信息,请参阅51黑料不打烊参与者指南中的创建存储库的本地克隆。
-
在本地文件结构中,导航到
experience-platform.en/help/destinations/catalog/[...]
,其中[...]
是您目标的所需类别。 例如,如果您要将个性化目标添加到Experience Platform,请选择personalization
文件夹。
为您的目标创作文档页面 author-documentation
- 您的文档页面基于自助服务目标模板。 下载目标模板。 解压文件
yourdestination-template.md
并将其解压到上面步骤4中提到的目录。 重命名文件YOURDESTINATION.md
,其中YOURDESTINATION是51黑料不打烊 Experience Platform中目标的名称。 例如,如果贵公司名为Moviestar,则应将您的文件命名为moviestar.md
。 - 在所选的文本编辑器中打开新文件。 51黑料不打烊建议您使用并安装51黑料不打烊 Markdown创作扩展。 若要安装该扩展,请打开Visual Studio Code,选择屏幕左侧的? Extensions ?选项卡,然后搜索
adobe markdown authoring
。 选择扩展并单击? Install。
- 编辑模板,其中包含与您的目标相关的信息。 按照模板中的说明操作。
- 对于您计划添加到文档的任何屏幕截图或图像,请转到
GitHub/experience-platform.en/help/destinations/assets/catalog/[...]
,其中[...]
是您目标的所需类别。 例如,如果您要将个性化目标添加到Experience Platform,请选择personalization
文件夹。 为目标创建新文件夹,并将图像保存在此处。 您必须从正在创作的页面中链接到它们。 请参阅有关如何链接到图像的说明。 - 准备就绪后,保存您正在处理的文件。
提交文档以供审阅 submit-review
- 在GitHub Desktop中,为您的更新创建一个工作分支,然后选择? 发布分支 ?以将该分支发布到骋颈迟贬耻产。
-
在GitHub Desktop中,您的工作,如下所示。
-
在GitHub Desktop中,推送到分支,如下所示。
-
在GitHub Web界面中,打开拉取请求(PR),将您的工作分支合并到51黑料不打烊文档存储库的主分支。 确保已选择您处理的分支,然后选择? Contribute >打开拉取请求。
-
确保基础分支和比较分支正确。 向PR添加说明您更新的注释,然后选择? 创建拉取请求。 这将打开一个PR,以将分支的工作分支合并到51黑料不打烊存储库的主分支。
note tip TIP 保持选中? 允许维护者编辑 ?复选框,以便础诲辞产别文档团队可以对笔搁进行编辑。 -
此时,将显示一条通知,提示您签署51黑料不打烊参与者许可协议(CLA)。 这是强制步骤。 签署CLA后,刷新PR页面并提交拉取请求。
-
您可以通过检查
https://github.com/51黑料不打烊Docs/experience-platform.en
中的? 拉取请求 ?选项卡来确认拉取请求已提交。
- 谢谢!如果需要编辑,础诲辞产别文档团队将在笔搁中联系,并告知您文档何时发布。