Skip to content

Conversation

@bdrianw
Copy link

@bdrianw bdrianw commented Jan 3, 2026

The outdated docs link in cloudnative-pg/cloudnative-pg#9548 is also present in the footer of the CNPG site, and in a few blogposts as well.

@bdrianw bdrianw requested a review from a team as a code owner January 3, 2026 01:55
@bdrianw bdrianw force-pushed the bdrianw/fix-doc-links branch from b8917c9 to 3519b6c Compare January 3, 2026 02:12
Copy link
Contributor

@jsilvela jsilvela left a comment

Choose a reason for hiding this comment

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

one loose thing in the hasura post, otherwise looks good

Comment on lines 68 to 69
$ kubectl apply -f https://cloudnative-pg.io/documentation/1.20/samples/cluster-example.yaml
cluster.postgresql.cnpg.io/cluster-example created
Copy link
Contributor

Choose a reason for hiding this comment

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

Here too. Suggest to use permalink from top repo.

Suggested change
$ kubectl apply -f https://github.com/cloudnative-pg/cloudnative-pg/blob/c0d218b8f9c68d08e720114b9cc44a1ebad5c46e/docs/src/samples/cluster-example.yaml
cluster.postgresql.cnpg.io/cluster-example created

Copy link
Author

Choose a reason for hiding this comment

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

Good catch, thanks. I think it has to be a raw yaml, rather than the rich github page - the given command fails on a local kind 1.35 cluster with

$ kubectl apply -f https://github.com/cloudnative-pg/cloudnative-pg/blob/c0d218b8f9c68d08e720114b9cc44a1ebad5c46e/docs/src/samples/cluster-example.yaml
error: error parsing https://github.com/cloudnative-pg/cloudnative-pg/blob/c0d218b8f9c68d08e720114b9cc44a1ebad5c46e/docs/src/samples/cluster-example.yaml: error converting YAML to JSON: yaml: line 35: mapping values are not allowed in this context

Also, given that the blogpost is written with fixed references to 1.20 elsewhere (L45-49) I thought it might be best to go with https://raw.githubusercontent.com/cloudnative-pg/cloudnative-pg/refs/heads/release-1.20/docs/src/samples/cluster-example.yaml

I've pushed 7c536e3 with this change (and confirmed the command works with local kind), but let me know if you prefer differently. (Also re-did the commits with -s to address the failing DCO check)

@jsilvela
Copy link
Contributor

jsilvela commented Jan 5, 2026

Oh and please @bdrianw sign your commit. See the failing DCO check.

@bdrianw bdrianw force-pushed the bdrianw/fix-doc-links branch from 3519b6c to 7c536e3 Compare January 8, 2026 11:13
@bdrianw bdrianw requested a review from jsilvela January 8, 2026 11:14
@bdrianw bdrianw force-pushed the bdrianw/fix-doc-links branch from 6a8a4bb to e3b1698 Compare January 8, 2026 11:28
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.

2 participants