Skip to content

Dynamic docs from catalog #2074

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Dynamic docs from catalog #2074

wants to merge 4 commits into from

Conversation

Lantero
Copy link

@Lantero Lantero commented Sep 23, 2025 •
edited
Loading

This is the OSS equivalent of https://github.com/grafana/website/pull/27448, which works fine.

The problem is that these shared layouts are only hosted in the website, which means the local preview is broken here, even though the final website would be ok.

@heitortsergent what is the recommended approach for using a shared layout in a place like this?

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 23, 2025 •
edited
Loading

💻 Deploy preview available:

@Lantero Lantero force-pushed the dynamic-extension-docs branch 4 times, most recently from d851ee9 to 843b4a6 Compare September 23, 2025 14:18
@Lantero Lantero force-pushed the dynamic-extension-docs branch from 843b4a6 to a6e03b5 Compare September 23, 2025 14:33
@Lantero Lantero marked this pull request as ready for review September 23, 2025 14:34
@Lantero Lantero requested review from heitortsergent and a team as code owners September 23, 2025 14:34
@Lantero Lantero requested review from szkiba, codebien and joanlopez and removed request for a team September 23, 2025 14:34
szkiba
szkiba approved these changes Sep 23, 2025
View reviewed changes
Copy link
Contributor

@szkiba szkiba left a comment

Choose a reason for hiding this comment

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

LGTM

codebien
codebien requested changes Sep 23, 2025
View reviewed changes
docs/sources/k6/next/extensions/explore.md Outdated
## Official extensions

{{< docs/shared source="k6" lookup="official-extensions.md" version="<K6_VERSION>" >}}
{{< docs/shared source="k6" lookup="official-extensions.html" version="<K6_VERSION>" >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Image

I guess this change is generating this error.

Copy link
Author

Choose a reason for hiding this comment

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

Yeah, I thought it was working in one of the previous previews, but it's not, I will put this back as a draft until I get it working

@Lantero Lantero marked this pull request as draft September 24, 2025 06:54
@Lantero Lantero marked this pull request as ready for review September 24, 2025 09:45
@heitortsergent
Copy link
Collaborator

@jdbaldry or @robbymilo, do you have any suggestions on how we can make the shared files work in the k6-docs without breaking the local/preview builds? 🤔

@jdbaldry
Copy link
Contributor

Are they not working with the docs/shared lookup? Did they break in #2038?

@jdbaldry
Copy link
Contributor

Or is the intent that you want to maintain the shortcode in the website repository as implemented in https://github.com/grafana/website/pull/27448/?

If that's the case, when we release a new version of the grafana/docs-base image, the shortcode will be available to local and preview builds.

@Lantero
Copy link
Author

Lantero commented Sep 24, 2025

Or is the intent that you want to maintain the shortcode in the website repository as implemented in grafana/website#27448?

If that's the case, when we release a new version of the grafana/docs-base image, the shortcode will be available to local and preview builds.

@jdbaldry does that mean that if I merge https://github.com/grafana/website/pull/27448 (Which works in its current form), a new grafana/docs-base image will be built, and then the builds/renders for this PR (k6-docs) will start working?

@jdbaldry
Copy link
Contributor

@jdbaldry does that mean that if I merge https://github.com/grafana/website/pull/27448 (Which works in its current form), a new grafana/docs-base image will be built, and then the builds/renders for this PR (k6-docs) will start working?

The build is nightly and promotions to latest are manual but yes :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@codebien codebien codebien requested changes

@szkiba szkiba szkiba approved these changes

@heitortsergent heitortsergent Awaiting requested review from heitortsergent heitortsergent is a code owner

@joanlopez joanlopez Awaiting requested review from joanlopez joanlopez is a code owner automatically assigned from grafana/k6-core

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Lantero @CLAassistant @heitortsergent @jdbaldry @codebien @szkiba