Skip to content

Contribution, Start Here (GitHub Method)

Jump to bottom
Joe Moore edited this page Jan 5, 2022 · 7 revisions

This guide is meant to walk you throught the process of contributing content to the Tanzu Developer Portal via GitHub and pull requests. This includes everything from ideation to review to eventual publishing.

NOTE: Some of these processes are for VMware employees only. Such processes will be noted.

Table of Contents - Contribute via GitHub and Pull Requests

  • Prewriting / Ideation

    • Is my content a good fit for the Tanzu Developer Center?
    • I want to create content for the Tanzu Developer Center, but I don’t know what to write.
    • I want to create content for the Tanzu Developer Center, and I do know what to write.
    • I have an idea for content to write, but I am not going to write it.

  • Drafting Content

    • I would like some tips on drafting Guides, Blogs, and other written content
    • I would like some tips on building Videos
    • I need help with adding images to my content
    • I need help filling out the front matter

  • Editing Content

    • My content needs to be reviewed prior to submission

  • Committing Content to be Published

    • I need a checklist to ensure my content is ready, prior to opening a pull request
    • I need to commit and push my code back to my branch, and open a pull request

  • Content Next Steps

    • I want to amplify my content via social media (VMware Employees Only)
    • This is my first time contributing to the Tanzu Developer Center, so I need to create an Author page

  • Optional: Setting Up You Environment to Create Content

    • I need to set up my local environment with the necessary tools to create and test content
    • I AM on the Tanzu Developer Center team with admin rights to the GitHub repository, and I need to clone the repository locally
    • I AM NOT on the Tanzu Developer Center team with admin rights to the GitHub repository, and I need to clone the repository locally
    • I need to create a content starter template, and I'm not sure which one

  • Optional: Testing Content Locally

    • I need to run tests locally, prior to submitting

Wiki Homepage

Quick References

Contributing: GitHub Method

  1. Start Here
  2. Prewriting / Ideation
  3. Setting Up You Environment to Create Content
  4. Drafting Content
  5. Editing Content
  6. Testing Content Locally
  7. Committing Content to be Published
  8. Content Next Steps

Contributing: Google Docs Method

  1. Start Here
  2. Prewriting / Ideation
  3. Tools you need (hint: it's Google Docs)
  4. Drafting Content
  5. Editing Content
  6. Contributing Content
Clone this wiki locally