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 docs deploy preview #2268

Merged
merged 2 commits into from
Dec 13, 2024
Merged

add docs deploy preview #2268

merged 2 commits into from
Dec 13, 2024

Conversation

robbymilo
Copy link
Contributor

@robbymilo robbymilo commented Dec 12, 2024

for https://github.com/grafana/website/issues/10101

What is this feature?

This PR adds a workflow to deploy the output of the make docs command to a public deploy preview.

Why do we need this feature?

Docs contributors will no longer need to run make docs on their machine, as they will be able to view the deploy preview instead.

Who is this feature for?

Everyone.

@robbymilo robbymilo requested a review from a team as a code owner December 12, 2024 08:43
@robbymilo robbymilo changed the title add docs deploy preview add docs deploy preview, update codeowners Dec 12, 2024
@robbymilo robbymilo changed the title add docs deploy preview, update codeowners add docs deploy preview Dec 12, 2024
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

I wonder if the maintainers would be happy with https://github.com/orgs/grafana/teams/docs-tooling/ becoming CODEOWNERS of https://github.com/grafana/alloy/pull/2268/files#diff-fcf14c4b7b34fe7a11916195871ae66a59be87a395f28db73e345ebdc828085bR12-R18

We'll need the team to be given write access to the repository

Copy link
Contributor

@ptodev ptodev left a comment

Choose a reason for hiding this comment

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

I suppose that the URL varies, and we'd need to check the CI log for the exact address each time?

Regarding the code owners - I'd be happy to change it to the docs tooling team. It makes more sense than assigning it just to one particular person anyway 😆 And it works better as people join and leave the team.

@robbymilo
Copy link
Contributor Author

Thanks @ptodev! Could you let me know when https://github.com/orgs/grafana/teams/docs-tooling/ is added to the repo? I will go ahead and update the codeowners in a different PR.

@jdbaldry
Copy link
Member

I suppose that the URL varies, and we'd need to check the CI log for the exact address each time?

A bot posts the URL as a comment as part of the workflow so you don't need to worry about checking the logs :)

Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

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

Happy to see this in Alloy. It's SUPER useful in the other repos.

@clayton-cornell clayton-cornell merged commit 5d5c055 into main Dec 13, 2024
18 checks passed
@clayton-cornell clayton-cornell deleted the robbymilo/add-deploy-preview branch December 13, 2024 13:42
@wildum
Copy link
Contributor

wildum commented Dec 13, 2024

This is awesome, thanks a lot!

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

Successfully merging this pull request may close these issues.

5 participants