Contribution, Editing Content (GitHub and Google Docs Method)

TDC Contribution Guide - Editing Content Prior to Submission

Prior to submitting PR of a content post to the Tanzu Developer Center, all posts need to go through several formal reviews. The reviews which may be necessary for all posts are:

My content needs to be reviewed prior to submission

1. Technical review and getting feedback (required) - Even if you are a subject matter expert for a particular piece of technology, all posts should first be reviewed for technical accuracy. The reviewer could be someone who is more knowledgable than you in the topic area. Or the reviewer could represent the audience you want to consume your content, and could review from a readability and understandability perspective.

   We encourage you to solicit feedback from peers who are experts in the subject matter. Within VMware, request feedback within the appropriate Slack channels and within #tanzu-development-center. Seek 1x1 feedback from individuals you know to be knowledgable in the subject. More collaboration usually means a better submission.

2. Copy Editing (required for written content only) - Once reviewed for technical accuracy, all posts need to go through copy editing to ensure compliance with the VMware style guide (VMware employees only) and the TDC style guide, as well as ensuring proper punctuation, grammar, voice, etc.

   NOTE: for VMware employees, we have copy editors available on staff. Ask the team in the #tanzu-developer-center Slack channel (VMware Employees Only) if you need help. However, our copy editors do not work with GitHub, and prefer Google Docs (or Word of you don't have access to Google Docs). Keeping content in a markdown format is generally fine. If you are submitting your content via a GitHub pull request, it is your responsibility to find a way to get your content into this format, edited by one of our editors, and back again.

3. Legal Review (may be required) (VMware employees only) - If your content deals with a VMware commercial product directly, or fi it includes forward looking statements about products or features, or if you think it might be required, submit your content for Legal review. This should be done after technical review and copy editing, and may require your content to go back through copy editing if the changes are significant.