Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update general documentation to comply with style guides #5158

Merged

Conversation

ppbaena
Copy link
Collaborator

@ppbaena ppbaena commented Aug 2, 2022

Description of the change

Update files in the root folder to comply with documentation style guides

  • ADOPTERS.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • GOVERNANCE.md
  • MAINTAINERS.md
  • README.md
  • ROADMAP.md
  • SECURITY.md

Benefits

Documentation updated and easy to follow and maintain by following the style guides.

Possible drawbacks

None.

Applicable issues

Additional information

This is the first PR to update all documentation according to style guides (tutorials, how-to guides, background and reference will follow).

@netlify
Copy link

netlify bot commented Aug 2, 2022

Deploy Preview for kubeapps-dev canceled.

Built without sensitive environment variables

Name Link
🔨 Latest commit d7a6b7d
🔍 Latest deploy log https://app.netlify.com/sites/kubeapps-dev/deploys/62ea3a0953f0320008c0cefe

@ppbaena ppbaena marked this pull request as ready for review August 2, 2022 15:06
Copy link
Collaborator

@castelblanque castelblanque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, many thanks for the update!

ppbaena and others added 3 commits August 3, 2022 11:03
Co-authored-by: Rafa Castelblanque <[email protected]>
Co-authored-by: Rafa Castelblanque <[email protected]>
Co-authored-by: Rafa Castelblanque <[email protected]>
@ppbaena
Copy link
Collaborator Author

ppbaena commented Aug 3, 2022

Thanks for double checking @castelblanque !

@ppbaena ppbaena merged commit ee6592a into vmware-tanzu:main Aug 4, 2022
@ppbaena ppbaena deleted the documentation/adapt-standard-guides branch August 4, 2022 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants