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

[bitnami/*] Remove relative links to non-README sections, add verification for that and update TL;DR section #20967

Merged
merged 8 commits into from
Nov 16, 2023

Conversation

jotamartos
Copy link
Contributor

@jotamartos jotamartos commented Nov 15, 2023

Description of the change

This PR ...

  • updates the links to not to use relative links to the values.yaml file or other files inside the templates folder
  • fixes some broken links that I found when working on the changes.
  • moves the references to the enterprise page to the tl;dr section to be customized in the future and replaces the placeholders in that section too

Benefits

We can use this documentation anywhere and the links won't be broken

Possible drawbacks

None

Applicable issues

Additional information

Checklist

  • [NA] Chart version bumped in Chart.yaml according to semver. This is not necessary when the changes only affect README.md files.
  • [NA] Variables are documented in the values.yaml and added to the README.md using readme-generator-for-helm
  • Title of the pull request follows this pattern [bitnami/<name_of_the_chart>] Descriptive title
  • All commits signed off and in agreement of Developer Certificate of Origin (DCO)

Sorry, something went wrong.

@bitnami-bot bitnami-bot added the verify Execute verification workflow for these changes label Nov 15, 2023
fmulero
fmulero previously approved these changes Nov 15, 2023
Copy link
Collaborator

@fmulero fmulero left a comment

Choose a reason for hiding this comment

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

LGTM

@jotamartos jotamartos removed the request for review from CeliaGMqrz November 15, 2023 11:39
carrodher
carrodher previously approved these changes Nov 15, 2023
Copy link
Member

@carrodher carrodher left a comment

Choose a reason for hiding this comment

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

LGTM, just an hyper-minor-picky comment

@jotamartos jotamartos dismissed stale reviews from carrodher and fmulero via 9f437f9 November 15, 2023 15:09
@jotamartos jotamartos force-pushed the remove-relative-links branch from fea4448 to 0d1996b Compare November 15, 2023 17:24
carrodher
carrodher previously approved these changes Nov 15, 2023
@jotamartos jotamartos changed the title [bitnami/*] Remove relative links to non-README sections and add verification [bitnami/*] Remove relative links to non-README sections, add verification for that and update TL;DR section Nov 16, 2023
@jotamartos jotamartos enabled auto-merge (squash) November 16, 2023 14:08
jotamartos and others added 8 commits November 16, 2023 15:18
…fication

Signed-off-by: Jota Martos <jotamartos@vmware.com>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Signed-off-by: Jota Martos <jotamartos@vmware.com>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>
Signed-off-by: Jota Martos <jotamartos@vmware.com>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Signed-off-by: Jota Martos <jotamartos@vmware.com>
Signed-off-by: Jota Martos <jotamartos@vmware.com>
Signed-off-by: Jota Martos <jotamartos@vmware.com>
Signed-off-by: Jota Martos <jotamartos@vmware.com>
This reverts commit 9f437f9.

Signed-off-by: Jota Martos <jotamartos@vmware.com>
@jotamartos jotamartos force-pushed the remove-relative-links branch from 32acd1c to 9e15f75 Compare November 16, 2023 14:18
@jotamartos jotamartos merged commit 1103633 into main Nov 16, 2023
@jotamartos jotamartos deleted the remove-relative-links branch November 16, 2023 14:18
garettmd pushed a commit to garettmd/odoo that referenced this pull request Jan 31, 2024
…ation for that and update TL;DR section (bitnami#20967)

* [bitnami/*] Remove relative links to non-README sections and add verification

Signed-off-by: Jota Martos <jotamartos@vmware.com>

* Update Elasticsearch solution title

Signed-off-by: Jota Martos <jotamartos@vmware.com>

* Update .github/workflows/markdown-linter.yml

Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>

* Move enterprise string to the tl;dr section

Signed-off-by: Jota Martos <jotamartos@vmware.com>

* Fix typo in some READMEs

Signed-off-by: Jota Martos <jotamartos@vmware.com>

* Replace placeholders in the TLDR section

Signed-off-by: Jota Martos <jotamartos@vmware.com>

* Fix typo in some READMEs

Signed-off-by: Jota Martos <jotamartos@vmware.com>

* Revert "Update Elasticsearch solution title"

This reverts commit 9f437f9.

---------

Signed-off-by: Jota Martos <jotamartos@vmware.com>
Signed-off-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>
Co-authored-by: Carlos Rodríguez Hernández <carlosrh@vmware.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bitnami solved verify Execute verification workflow for these changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants