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

Add guidelines for documentation style #5020

Merged
merged 2 commits into from
Jul 7, 2022

Conversation

ppbaena
Copy link
Collaborator

@ppbaena ppbaena commented Jul 5, 2022

Description of the change

Add writing style guidelines to follow for the Kubeapps documentation

Benefits

Make Kubeapps documentation clearer, more homogeneous and simple for contributors and users.

Possible drawbacks

Guidelines to follow in Kubeapps documentation, so a revision of Kubeapps documentation is necessary.

Applicable issues

@netlify
Copy link

netlify bot commented Jul 5, 2022

Deploy Preview for kubeapps-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f937eb8
🔍 Latest deploy log https://app.netlify.com/sites/kubeapps-dev/deploys/62c540217491a80009b3c718
😎 Deploy Preview https://deploy-preview-5020--kubeapps-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@antgamdia
Copy link
Contributor

Failing just because of #5013

@castelblanque
Copy link
Collaborator

so a revision of Kubeapps documentation is necessary.

This might be a huge task, but for sure we need to do it sooner or later.

@ppbaena ppbaena merged commit 382a7c8 into vmware-tanzu:main Jul 7, 2022
@ppbaena ppbaena deleted the doc/style-guide branch July 7, 2022 06:52
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.

Kubeapps style-guide
4 participants