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

Add artifacthub shortcode #50

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add artifacthub shortcode #50

wants to merge 1 commit into from

Conversation

alban
Copy link
Member

@alban alban commented Jul 8, 2024

Following guide:
https://artifacthub.io/docs/topics/embedding_artifacts/

We can embed the gadgets we publish on the Artifact Hub.

This patch does not change the content of the website but merely allows the docs to use the following in the markdown:

{{< artifacthub >}}

That could be used later in:
./external-docs/inspektor-gadget.git_mainlatest/docs/gadgets/_index.md

See #42

How to use

In the Inspektor Gadget main repository, we can have docs/gadgets/_index.md with the following content:

---
title: Gadgets
description: >
  This section provides guides for image-based gadgets.
weight: 35
---

{{< artifacthub >}}

Testing done

make run

image

cc @blixtra @mayasingh17 @mauriciovasquezbernal

Following guide:
https://artifacthub.io/docs/topics/embedding_artifacts/

We can embed the gadgets we publish on the Artifact Hub.

This patch does not change the content of the website but merly allows the docs to use the following in the markdown:
{{< artifacthub >}}

That could be used later in:
./external-docs/inspektor-gadget.git_mainlatest/docs/gadgets/_index.md

Signed-off-by: Alban Crequy <[email protected]>
Copy link

github-actions bot commented Jul 8, 2024

Azure Static Web Apps: Your stage site is ready! Visit it here: https://polite-mushroom-00d947803-50.westeurope.1.azurestaticapps.net

@alban
Copy link
Member Author

alban commented Jul 9, 2024

Azure Static Web Apps: Your stage site is ready! Visit it here: https://polite-mushroom-00d947803-50.westeurope.1.azurestaticapps.net

Note that there is nothing new to see there: as explained in the PR, the main IG repository needs to change to make use of the shortcode introduced here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant