search

githedgehog / dataplane

The hedgehog dataplane
Apache License 2.0
2 stars 1 forks source link

CI: Avoid publishing docs on Pull Requests (or use a preview URL) #20

Closed qmonnet closed 1 month ago

qmonnet commented 2 months ago

We currently push a new version of the docs each time a PR touches the docs. We don't want that. We should only build a preview, not using the official doc URL, when we create/update a PR.

daniel-noland commented 2 months ago

Fully agree. Will look into it

Frostman commented 2 months ago

GitHub Pages could be better for publishing previews. One straightforward approach is to publish to Netlify, which we currently use for all Hedgehog docs. You can see setup in docs repo https://github.com/githedgehog/docs/tree/master/.github/workflows which will give you comments with per-PR published version of the docs https://github.com/githedgehog/docs/pull/38#issuecomment-2291150238

qmonnet commented 2 months ago

Side note: Based on this setting I'm not sure we're actually updating the docs for PRs:

image

but it would be good to have previews.

Regarding Netlify: Yes, it works well, this is what Cilium uses for doc previews. I'd have publication and previews with the same provider if possible, but otherwise Netlify would be my favoured option as well.

Frostman commented 2 months ago

if you'll go with Netlify path - let me know, I can create app/token for you in the hedgehog account

qmonnet commented 2 months ago

@Frostman Yes please, we'll use Netlify for the previews