Skip to content
This repository has been archived by the owner on Aug 10, 2023. It is now read-only.

Latest commit

 

History

History
53 lines (36 loc) · 3.26 KB

write.md

File metadata and controls

53 lines (36 loc) · 3.26 KB
Raw
title description author tags date_published
Contribute a document for the Google Cloud Community site
Learn how to submit a tutorial or other document for the Google Cloud community site.
kopriva
template, submit
2020-09-21

We welcome the contribution of any tutorial or other document that shares knowledge about how to use Google Cloud.

The source for each document is a Markdown file in the Google Cloud Community GitHub repository. Each document may be accompanied by example source code and other assets alongside the document in the repository.

Accept the Contributor License Agreement

For us to accept your contributions, we need you to sign the Contributor License Agreement (CLA):

  • If you are an individual writing original content and you own the intellectual property, then you sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you sign a corporate CLA.

Contribute a document

  1. Read the style guide before preparing your submission.

  2. Fork the github.com/GoogleCloudPlatform/community repository.

  3. Do one of the following to add the new document file:

    • If you are contributing a single document file with no supporting code or image files, then create a uniquely named .md file at the top level of the tutorials folder.
    • If you are contributing a document with supporting code or image files, then create a new folder for your document in the tutorials folder and create an index.md file at the top level of that subfolder.

    For details, see File organization and naming in GitHub.

  4. Copy the Markdown source contents of the tutorial template into your new Markdown file.

  5. Replace the template content with your own document content, following the instructions in the template and style guide.

  6. Commit your changes and open a pull request.

    After you create a pull request, a reviewer reviews your submission. The reviewer will directly make some editorial and production changes to the document to ensure that it follows the guidelines. The reviewer may also leave comments asking for changes or clarifications.

  7. Work with the reviewer to resolve any issues found during the review.

After your pull request is approved, the reviewer will merge the pull request. New documents and fixes are typically published to the Google Cloud Community site within a few days of pull requests being merged.