Update general documentation to comply with style guides (#5158)

* Update README.md to comply the documentation style guide * Update Adopters page and logos * Update maintainers to add @beni0888 and Kubeapps roadmap to include FY23-Q3 * Update CONTRIBUTING.md Co-authored-by: Rafa Castelblanque <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Rafa Castelblanque <[email protected]> * Update ROADMAP.md Co-authored-by: Rafa Castelblanque <[email protected]> Co-authored-by: Rafa Castelblanque <[email protected]>
vmware-tanzu · Aug 4, 2022 · ee6592a · ee6592a
1 parent eaa4757
commit ee6592a
Show file tree

Hide file tree

Showing 11 changed files with 61 additions and 60 deletions.
diff --git a/ADOPTERS.md b/ADOPTERS.md
@@ -4,15 +4,15 @@ If you're using Kubeapps and want to add your organization to this list, follow
 
 ## Organizations using Kubeapps
 
-<a href="https://www.coreweave.com/" border="0" target="_blank"><img alt="CoreWeave" src="./site/content/docs/latest/img/adopters/coreweave.svg" height="90" style="background-color: #FFF;"></a>
+<a href="https://www.coreweave.com/" border="0" target="_blank"><img alt="CoreWeave" src="./site/content/docs/latest/img/adopters/coreweave.jpg" height="90"></a>
 
-<a href="https://h8l.io/" border="0" target="_blank"><img alt="h8lio" src="./site/content/docs/latest/img/adopters/h8lio.svg" height="70" style="background-color: #FFF;"></a>
+<a href="https://h8l.io/" border="0" target="_blank"><img alt="h8lio" src="./site/content/docs/latest/img/adopters/h8lio.jpg" height="70"></a>
 
-<a href="https://www.ledger.com/" border="0" target="_blank"><img alt="Ledger" src="./site/content/docs/latest/img/adopters/ledger.svg" height="50" style="background-color: #FFF;"></a>
+<a href="https://www.ledger.com/" border="0" target="_blank"><img alt="Ledger" src="./site/content/docs/latest/img/adopters/ledger.jpg" height="50"></a>
 
-<a href="https://otomi.io/" border="0" target="_blank"><img alt="Otomi" src="./site/content/docs/latest/img/adopters/otomi.svg" height="70" style="background-color: #FFF;"></a>
+<a href="https://otomi.io/" border="0" target="_blank"><img alt="Otomi" src="./site/content/docs/latest/img/adopters/otomi.jpg" height="70"></a>
 
-<a href="https://www.terasky.com/" border="0" target="_blank"><img alt="Terasky" src="./site/content/docs/latest/img/adopters/terasky.svg" height="40" style="background-color: #FFF;"></a>
+<a href="https://www.terasky.com/" border="0" target="_blank"><img alt="Terasky" src="./site/content/docs/latest/img/adopters/terasky.jpg" height="40"></a>
 
 ## Success Stories
 
@@ -44,10 +44,10 @@ TeraSky is a Global Advanced Technology Solutions Provider. We utilize Kubeapps
 
 ## Adding your organization to the list of adopters
 
-If you are using Kubeapps and would like to be included in the list of Kubeapps Adopters it is possible through the following options:
+If you are using Kubeapps and would like to include your organization/use case in the list of Kubeapps Adopters it is possible through the following options:
 
-- **Send a PR**: add an SVG/PNG version of your logo to the [img/adopters directory](./site/content/docs/latest/img/adopters/) in this repo and submit a pull request with your change including 1-2 sentences describing how your organization is using Kubeapps. Name the image file something that reflects your company (e.g., if your company is called Acme, name the image acme.svg).
+- **Send a PR**: add an jpg/PNG version of your logo to the [img/adopters directory](./site/content/docs/latest/img/adopters/) in this repo and submit a pull request with your change including 1-2 sentences describing how your organization use Kubeapps. Name the image file something that reflects your company (e.g., if your company is called Acme, name the image acme.jpg).
 - **Slack**: Open a new thread in the [Kubeapps slack channel](https://kubernetes.slack.com/messages/kubeapps) with the request and the information described above.
-- **Email**: Directly contact through [email](mailto:[email protected]) to our DL.
+- **Email**: Directly contact through [email](mailto:[email protected]) to Kubeapps maintainers DL.
 
-Project maintainers will help and assess to include your organization as a Kubeapps adopter. Please feel free to send us a message in [#kubeapps](https://kubernetes.slack.com/messages/kubeapps) with any questions you may have.
+Project maintainers will help and assess to include your organization as a Kubeapps adopter. Please feel free to send a message in [#kubeapps](https://kubernetes.slack.com/messages/kubeapps) with any questions you may have.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,46 +1,46 @@
 # Contributing to Kubeapps
 
-We welcome contributions from the community and first want to thank you for taking the time to contribute!
+Kubeapps maintainers welcome contributions from the community and first want to thank you for taking the time to contribute!
 
 Please familiarize yourself with the [Code of Conduct](https://github.com/vmware/.github/blob/main/CODE_OF_CONDUCT.md) before contributing.
 
-* _CLA: Before you start working with Kubeapps, please read and sign our Contributor License Agreement [CLA](https://cla.vmware.com/cla/1/preview). If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq)._
+- _CLA: Before you start working with Kubeapps, please read and sign our Contributor License Agreement [CLA](https://cla.vmware.com/cla/1/preview). If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq)._
 
 ## Ways to contribute
 
-We welcome many different types of contributions and not all of them need a Pull request. Contributions may include:
+Kubeapps project welcomes many different types of contributions and not all of them need a Pull request. Contributions may include:
 
-* New features and proposals
-* Documentation
-* Bug fixes
-* Issue Triage
-* Answering questions and giving feedback
-* Helping to onboard new contributors
-* Other related activities
+- New features and proposals
+- Documentation
+- Bug fixes
+- Issue Triage
+- Answering questions and giving feedback
+- Helping to onboard new contributors
+- Other related activities
 
 ## Getting started
 
-Find information about how to set up the development environment on this [developer guide](./site/content/docs/latest/reference/developer/README.md).
+Find information about how to set up the development environment on the [developer guide](./site/content/docs/latest/reference/developer/README.md).
 
 ## Contribution Flow
 
 This is a rough outline of what a contributor's workflow looks like:
 
-* Make a fork of the repository within your GitHub account
-* Create a topic branch in your fork from where you want to base your work
-* Make commits of logical units
-* Make sure your commit messages are with the proper format, quality and descriptiveness (see below)
-* Push your changes to the topic branch in your fork
-* Create a pull request containing that commit
+- Make a fork of the repository within your GitHub account
+- Create a topic branch in your fork from where you want to base your work
+- Make commits of logical units
+- Make sure your commit messages are with the proper format, quality and descriptiveness (see below)
+- Push your changes to the topic branch in your fork
+- Create a pull request containing that commit
 
-We follow the GitHub workflow and you can find more details on the [GitHub flow documentation](https://docs.github.com/en/get-started/quickstart/github-flow).
+Kubeapps maintainers team follow the GitHub workflow and you can find more details on the [GitHub flow documentation](https://docs.github.com/en/get-started/quickstart/github-flow).
 
-Before submitting your pull request, we advise you to use the following:
+Before submitting your pull request use the following checklist:
 
 ### Pull Request Checklist
 
 1. Check if your code changes will pass both code linting checks and unit tests.
-2. Ensure your commit messages are descriptive. We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/). Be sure to include any related GitHub issue references in the commit message. See [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues and commits.
+2. Ensure your commit messages are descriptive. Kubeapps follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/). Be sure to include any related GitHub issue references in the commit message. See [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues and commits.
 3. Check the commits and commits messages and ensure they are free from typos.
 4. Any pull request which adds a new feature or changes the behavior of any feature which was previously documented should include updates to the documentation. All documentation lives in this repository.
 
@@ -50,43 +50,43 @@ For specifics on what to include in your report, please follow the guidelines in
 
 ### Issues
 
-Need an idea for a project to get started contributing? Take a look at the [open issues](https://github.com/vmware-tanzu/kubeapps/issues?q=is%3Aopen+is%3Aissue). Also check to see if any open issues are labeled with ["good first issue"](https://github.com/vmware-tanzu/kubeapps/labels/good%20first%20issue) or ["help wanted"](https://github.com/vmware-tanzu/kubeapps/labels/help%20wanted).
+Need an idea for a project to get started contributing? Take a look at the [open issues](https://github.com/vmware-tanzu/kubeapps/issues?q=is%3Aopen+is%3Aissue). Also check to see if any open issues are labeled with [`good first issue`](https://github.com/vmware-tanzu/kubeapps/labels/good%20first%20issue) or [`help wanted`](https://github.com/vmware-tanzu/kubeapps/labels/help%20wanted).
 
 When contributing to Kubeapps, please first discuss the change you wish to make via an issue with this repository before making a change.
 
 > Kubeapps distribution is delegated to the official [Bitnami Kubeapps chart](https://github.com/bitnami/charts/tree/master/bitnami/kubeapps) from the separate Bitnami charts repository. PRs and issues related to the official chart should be created in the Bitnami charts repository.
 
 ### Bugs
 
-To file a bug report, please first open an [issue](https://github.com/vmware-tanzu/kubeapps/issues/new?assignees=&labels=kind%2Fbug&template=bug_report.md&title=). The project team will work with you on your bug report.
+To file a bug report, please first open an [issue](https://github.com/vmware-tanzu/kubeapps/issues/new?assignees=&labels=kind%2Fbug&template=bug_report.md&title=). The project maintainers team will work with you on your bug report.
 
 Once the bug has been validated, a [pull request](https://github.com/vmware-tanzu/kubeapps/compare) can be opened to fix the bug.
 
 For specifics on what to include in your bug report, please follow the guidelines in the issue and pull request templates.
 
 ### Features
 
-To suggest a feature, please first open an [issue](https://github.com/vmware-tanzu/kubeapps/issues/new?assignees=&labels=kind%2Ffeature&template=feature_request.md&title=) that will be tagged with ["kind/proposal"](https://github.com/vmware-tanzu/kubeapps/labels/kind%2Fproposal), or create a new [Discussion](https://github.com/vmware-tanzu/kubeapps/discussions/new). The project maintainers will work with you on your feature request.
+To suggest a feature, please first open an [issue](https://github.com/vmware-tanzu/kubeapps/issues/new?assignees=&labels=kind%2Ffeature&template=feature_request.md&title=) that will be tagged with [`kind/proposal`](https://github.com/vmware-tanzu/kubeapps/labels/kind%2Fproposal), or create a new [Discussion](https://github.com/vmware-tanzu/kubeapps/discussions/new). The project maintainers will work with you on your feature request.
 
 Once the feature request has been validated, a pull request can be opened to implement the feature.
 
 For specifics on what to include in your feature request, please follow the guidelines in the issue and pull request templates.
 
 ## Ask for Help
 
-The best way to reach us with a question when contributing is to ask on:
+The best way to reach Kubeapps maintainers team with a question when contributing is to ask on:
 
-* [GitHub Issues](https://github.com/vmware-tanzu/kubeapps/issues)
-* [GitHub Discussions](https://github.com/vmware-tanzu/kubeapps/discussions)
-* [#kubeapps Slack channel](https://kubernetes.slack.com/messages/kubeapps)
+- [GitHub Issues](https://github.com/vmware-tanzu/kubeapps/issues)
+- [GitHub Discussions](https://github.com/vmware-tanzu/kubeapps/discussions)
+- [#kubeapps Slack channel](https://kubernetes.slack.com/messages/kubeapps)
 
 ## Additional Resources
 
 New to Kubeapps?
 
-* Start here to learn how to install and use Kubeapps: [Getting started in Kubeapps](./site/content/docs/latest/tutorials/getting-started.md)
-* Start here to learn how to develop for Kubeapps components: [Kubeapps Developer guidelines](./site/content/docs/latest/reference/developer/README.md)
-* Other more detailed documentation can be found at: [Kubeapps Docs](./site/content/docs/latest/README.md)
+- Start here to learn how to install and use Kubeapps: [Getting started in Kubeapps](./site/content/docs/latest/tutorials/getting-started.md)
+- Start here to learn how to develop for Kubeapps components: [Kubeapps Developer guidelines](./site/content/docs/latest/reference/developer/README.md)
+- Other more detailed documentation can be found at: [Kubeapps Docs](./site/content/docs/latest/README.md)
 
 ## Roadmap
 

diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -7,6 +7,7 @@
 | Antonio Gámez Díaz | [antgamdia](https://github.com/antgamdia)           | [VMware](https://www.github.com/vmware/) |
 | Dimitri Laloue     | [dlaloue-vmware](https://github.com/dlaloue-vmware) | [VMware](https://www.github.com/vmware/) |
 | Greg Fichtenholtz  | [gfichtenholt](https://github.com/gfichtenholt)     | [VMware](https://www.github.com/vmware/) |
+| Jesús Benito       | [beni0888](https://github.com/beni0888)             | [VMware](https://www.github.com/vmware/) |
 | Michael Nelson     | [absoludity](https://github.com/absoludity)         | [VMware](https://www.github.com/vmware/) |
 | Pepe Baena         | [ppbaena](https://github.com/ppbaena)               | [VMware](https://www.github.com/vmware/) |
 | Rafa Castelblanque | [castelblanque](https://github.com/castelblanque)   | [VMware](https://www.github.com/vmware/) |
@@ -25,6 +26,6 @@
 | ------------------- | ------------------------------------------------------------ |
 | Technical Lead      | Michael Nelson ([absoludity](https://github.com/absoludity)) |
 | Engineering Manager | Pepe Baena ([ppbaena](https://github.com/ppbaena))           |
-| Executive Owner     | Arun Goel                                                    |
+| Executive Owner     | Ashok Aletty                                                 |
 
 Full list of [Kubeapps contributors](https://github.com/vmware-tanzu/kubeapps/graphs/contributors).
diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@ Kubeapps is an in-cluster web-based application that enables users with a one-ti
 
 With Kubeapps you can:
 
-- Customize deployments through an intuitive, form-based user interface
-- Inspect, upgrade and delete applications installed in the cluster
-- Browse and deploy [Helm](https://github.com/helm/helm) charts from public or private chart repositories (including [VMware Marketplace™](https://marketplace.cloud.vmware.com) and [Bitnami Application Catalog](https://bitnami.com/application-catalog))
+- Browse and deploy different packages like [Helm](https://github.com/helm/helm) charts, [Flux](https://fluxcd.io/) or [Carvel](https://carvel.dev/) packages from public or private repositories (including [VMware Marketplace™](https://marketplace.cloud.vmware.com) and [Bitnami Application Catalog](https://bitnami.com/application-catalog))
+- Customize deployments through an intuitive user interface
+- Browse, upgrade and delete applications installed in the cluster
 - Browse and deploy [Kubernetes Operators](https://operatorhub.io/)
 - Secure authentication to Kubeapps using a [standalone OAuth2/OIDC provider](./site/content/docs/latest/tutorials/using-an-OIDC-provider.md) or [using Pinniped](./site/content/docs/latest/howto/OIDC/using-an-OIDC-provider-with-pinniped.md)
 - Secure authorization based on Kubernetes [Role-Based Access Control](./site/content/docs/latest/howto/access-control.md)
@@ -34,7 +34,9 @@ See the [Getting Started Guide](./site/content/docs/latest/tutorials/getting-sta
 
 ## Documentation
 
-Please refer to:
+Complete documentation available in Kubeapps [documentation section](./site/content/docs/latest/README.md). Including complete tutorials, how-to guides, and reference for configuration and development in Kubeapps.
+
+For getting started into Kubeapps, please refer to:
 
 - [Getting started guide](./site/content/docs/latest/tutorials/getting-started.md)
 - [Detailed installation instructions](./chart/kubeapps/README.md)
@@ -45,15 +47,15 @@ See how to deploy and configure [Kubeapps on VMware Tanzu™ Kubernetes Grid™]
 
 ## Troubleshooting
 
-If you encounter issues, review the [troubleshooting docs](./chart/kubeapps/README.md#troubleshooting), review our [project board](https://github.com/orgs/vmware-tanzu/projects/38/views/2), file an [issue](https://github.com/vmware-tanzu/kubeapps/issues), or talk to us on the [#Kubeapps channel](https://kubernetes.slack.com/messages/kubeapps) on the Kubernetes Slack server.
+If you encounter issues, please review the [troubleshooting docs](./chart/kubeapps/README.md#troubleshooting), review our [project board](https://github.com/orgs/vmware-tanzu/projects/38/views/2), file an [issue](https://github.com/vmware-tanzu/kubeapps/issues), or talk to Kubeapps maintainers on the [#Kubeapps channel](https://kubernetes.slack.com/messages/kubeapps) on the Kubernetes Slack server.
 
-- Click [here](https://slack.k8s.io) to sign up to the Kubernetes Slack org.
+- [Sign up](https://slack.k8s.io) to the Kubernetes Slack org.
 
-- Review our FAQs section on the [Kubeapps chart README](./chart/kubeapps/README.md#faq).
+- Review the FAQs section on the [Kubeapps chart README](./chart/kubeapps/README.md#faq).
 
 ## Contributing
 
-If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [start contributing](./CONTRIBUTING.md) documentation for guidance on how to setup Kubeapps for development.
+If you are ready to jump in and test, add code, or help with documentation, follow the instructions on the [start contributing](./CONTRIBUTING.md) documentation for guidance on how to setup Kubeapps for development.
 
 ## Changelog