MonkeyCanCode opened a new pull request, #3738: URL: https://github.com/apache/polaris/pull/3738
<!-- ๐ Describe what changes you're proposing, especially breaking or user-facing changes. ๐ See https://github.com/apache/polaris/blob/main/CONTRIBUTING.md for more. --> As we are publishing our [apache polaris](https://artifacthub.io/packages/helm/apache-polaris/polaris) helm chart on artifact hub, the existed `README.md` has a bit too much context. Based on the [ML](https://lists.apache.org/thread/03kw8or2n69olvvn8y51o5cnt08sctqq) discussion, [apache airflow](https://artifacthub.io/packages/helm/apache-airflow/airflow) has a very clean README as the front page for artifact hub. Also, looking at [apache spark](https://artifacthub.io/packages/helm/spark-kubernetes-operator/spark-kubernetes-operator), it follows the similar layout as well. This PR contains the following changes: 1. Follow the same layout with two documents by keeping the main `README.md` clean as that is the display page on artifact hub 2. Changed existed `README.md.gotmpl` to `helm.md.gotmpl` to continue support the detail helm page from our official site and updated `Makefile` to reflect this change of path 3. Updated `helm/polaris/.helmignore` as existed packaged helm has a lot more things such as ci and tests which are not necessary for a helm chart 4. Updated `.gitignore` to exclude `helm/polaris/helm.md` as that is temporary file right now to power `Makefile` with our detail helm page update. ## Checklist - [x] ๐ก๏ธ Don't disclose security issues! (contact [email protected]) - [x] ๐ Clearly explained why the changes are needed, or linked related issues: Fixes # - [x] ๐งช Added/updated tests with good coverage, or manually tested (and explained how) - [x] ๐ก Added comments for complex logic - [x] ๐งพ Updated `CHANGELOG.md` (if needed) - [x] ๐ Updated documentation in `site/content/in-dev/unreleased` (if needed) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
