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: Add publishing guide #2555

Merged
merged 1 commit into from
Nov 11, 2024
Merged

docs: Add publishing guide #2555

merged 1 commit into from
Nov 11, 2024

Conversation

joaquimrocha
Copy link
Collaborator

Here are the docs for the plugin publishing guide.
After putting these together, I have 2 remarks:

  1. I still feel like the guide would make more sense if we add the repo in ArtifactHub and only then add the files to the github page, same with the package. Just would feel more natural to me: I create a repo in AH, then enable it.
  2. The guide is for publishing on ArtifactHub which has little to do with Headlamp and more to do with the Plugin Catalog, but it's important enough that I think it's okay to have it here. I added some text explaining that it's not about discoverability on Headlamp core but rather in the plugin.

cc/ @yolossn

@joaquimrocha joaquimrocha requested a review from blixtra November 11, 2024 00:35
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Nov 11, 2024
@joaquimrocha joaquimrocha added the documentation Improvements or additions to documentation label Nov 11, 2024
@yolossn
Copy link
Contributor

yolossn commented Nov 11, 2024

Just would feel more natural to me: I create a repo in AH, then enable it.

I see it differently because the 'Add repository' button in ArtifactHub suggests linking an existing GitHub repository that already contains the Headlamp plugin templates, rather than creating a new repository in ArtifactHub itself. If you feel its better the other way, feel free to change it

Copy link
Contributor

@skoeva skoeva left a comment

Choose a reason for hiding this comment

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

Added some suggestions for clarity

docs/development/plugins/publishing.md Outdated Show resolved Hide resolved
docs/development/plugins/publishing.md Outdated Show resolved Hide resolved
docs/development/plugins/publishing.md Outdated Show resolved Hide resolved
docs/development/plugins/publishing.md Outdated Show resolved Hide resolved
@joaquimrocha joaquimrocha force-pushed the plugin-publishing-guide branch 2 times, most recently from 0014977 to d19b339 Compare November 11, 2024 22:17
Co-authored-by: Santhosh Nagaraj <sannagaraj@microsoft.com>

Signed-off-by: Joaquim Rocha <joaquim.rocha@microsoft.com>
@joaquimrocha joaquimrocha force-pushed the plugin-publishing-guide branch from d19b339 to 945112a Compare November 11, 2024 22:19
@joaquimrocha joaquimrocha merged commit 60f43fc into main Nov 11, 2024
9 checks passed
@joaquimrocha joaquimrocha deleted the plugin-publishing-guide branch November 11, 2024 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants