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

docs: move chartmuseum info into private packages page #12095

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented Oct 10, 2021

Changes:

  • Move chartmuseum info into getting-started/private-packages.md
  • Add link to private packages from helm-requirements/readme.md

EDIT: Updated the changes section, kept the original context at time of opening the issue.

Context:

@dudicoco said 1 that the chartmuseum information that's placed in the Docker docs should go in the helm-requirements manager docs instead.

I don't know if I can use a h2 heading in this file, or if that will mess up the display of the published page. I think no other manager readme file has headings in it? The pattern to check would be lib/manager/manager-name/readme.md.
Turns out I'm not allowed to use h1 or h2 headings. 🙈

 FAIL lib/manager/metadata.spec.ts (262 MB heap size)
  ● manager/metadata › helm-requirements has readme with no h1 or h2

I'm not sure if this is a better place than in the Docker docs, it depends where people will think to look.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

Footnotes

  1. https://github.com/renovatebot/renovate/issues/12093

Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

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

🤔 i think this is better suited at helm datasource or our private modules page.

It should also have a hostType to not collide with default host rules.

@dudicoco
Copy link
Contributor

@HonkingGoose this applies to standard helm repositories as well (not hosted via chartmuseum), so I believe the docs should reflect that

@HonkingGoose
Copy link
Collaborator Author

HonkingGoose commented Oct 13, 2021

@HonkingGoose this applies to standard helm repositories as well (not hosted via chartmuseum), so I believe the docs should reflect that

That runs the risk of duplicating the information in multiple places though. I'd prefer to have a single location for this text. I'm okay with adding links to the canonical text in other places.

@HonkingGoose HonkingGoose changed the title docs: move chartmuseum info into helm-requirements docs: move chartmuseum info into private packages page Oct 16, 2021
@HonkingGoose HonkingGoose marked this pull request as ready for review October 20, 2021 10:07
@rarkins rarkins merged commit 9f08a79 into renovatebot:main Oct 20, 2021
@HonkingGoose HonkingGoose deleted the docs/move-chartmuseum-info-into-helm-requirements branch October 20, 2021 11:23
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 28.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants