crossplane / docs

Repo for Crossplane documentation.
https://docs.crossplane.io
Other
49 stars 112 forks source link

Broken Links found for install-configure #813

Open tr0njavolta opened 1 month ago

tr0njavolta commented 1 month ago

What's Wrong?

A 404 from https://docs.crossplane.io/latest/getting-started/install-configure.html Should be https://docs.crossplane.io/latest/software/ instead.

This URL structure is found in content/media/snippets/package/gcp/crossplane.yaml, content/media/snippets/package/aws/crossplane.yaml, content/media/snippets/package/azure/crossplane.yaml, content/media/snippets/package/aws-with-vpc/crossplane.yaml

I'm not sure what the snippets directory is used for, but the entire crossplane docs domain is getting crawled by the new chatbot on https://www.upbound.io and the incorrect link is being given to users.

plumbis commented 1 month ago

Snippets is a hold over of the legacy docs site. @ytsarev had some use cases for it, but it's not used inside the docs any longer.

ytsarev commented 1 month ago

Yep, in the old doc setup, I used snippets as a source of examples. Now, all required code samples can be found on the documentation website, so I no longer need them.