How service providers publish service documentation to the Compute Nest GitHub documentation repository-Compute Nest(Compute Nest)-阿里云帮助中心

This topic explains how service providers publish service documentation to the Compute Nest GitHub documentation repository.

Prerequisites

You have a published service.

Procedure

To request a documentation repository, submit a ticket. Alternatively, you can scan the QR code in the Compute Nest console to join the technical support group on DingTalk.

Note
In the ticket description, provide the name of your service in both English and Chinese.
Compute Nest generates a GitHub documentation repository link based on the product name in your ticket. For example: https://github.com/aliyun-computenest/quickstart-gbase.
After you receive the GitHub documentation repository link, fork the repository and add your deployment documentation.

Name the file index.md and place it in the doc directory. You can add the file by either uploading it directly or by cloning the repository and pushing your changes.
- Upload a local file
  1. In your forked GitHub repository, click Add file, and then select Upload files.
  2. On the upload page, upload your local document.
  After the upload is complete, enter a commit message in the Commit changes section, select Commit directly to the main branch., and then click Commit changes.

Clone the repository and push your changes
1. Clone the forked repository to your local machine and add the documentation.
2. Run git push to push your changes to the remote repository.
After updating the repository, click Pull requests to propose merging your changes into the main branch.
Click New pull request. After the Compute Nest team reviews and approves your pull request, your changes are automatically merged into the main branch and published online.

Next steps

After the documentation is published, go to the Create Service Instance page and click Usage notes on service deployment to view the detailed deployment guide.