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

Update broken links to Crossplane documentation #271

Open
mergenci opened this issue Sep 6, 2023 · 2 comments
Open

Update broken links to Crossplane documentation #271

mergenci opened this issue Sep 6, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request is:triaged
Milestone

Comments

@mergenci
Copy link
Member

mergenci commented Sep 6, 2023

What problem are you facing?

In documentation, 5/6 links to Crossplane documentation are broken — they return 404 Not Found. Here are the links to Crossplane documentation I found using grep "docs/v1." docs/* (link titles are links to lines in the version control):

  1. add-new-resource-long.md:[the external name documentation]: https://crossplane.io/docs/v1.7/concepts/managed-resources.html#external-name
  2. add-new-resource-long.md:[handle dependencies]: https://crossplane.io/docs/v1.7/concepts/managed-resources.html#dependencies
  3. add-new-resource-long.md:[connection details]: https://crossplane.io/docs/v1.7/concepts/managed-resources.html#connection-details
  4. reference-generation.md:[Dependencies]: https://crossplane.io/docs/v1.7/concepts/managed-resources.html#dependencies
  5. testing-instructions.md:[the documentation]: https://crossplane.io/docs/v1.9/getting-started/install-configure.html#install-configuration-package
  6. This link is not broken. testing-instructions.md:[Late Initialization]: https://crossplane.io/docs/v1.9/concepts/managed-resources.html#late-initialization

For convenience, I've located relevant Crossplane documentation before they were removed from version control, in case you would like to see what broken links used to refer to: v1.9, v1.7

How could Upjet help solve your problem?

Some of the links might have gone broken because of simple title changes in the Crossplane documentation. Those should be easy to fix. Some of them, though, refer to obsolete features (Number 5 above?); therefore, may require updating Upjet documentation accordingly.

@mergenci mergenci added enhancement New feature or request needs:triage labels Sep 6, 2023
@jeanduplessis
Copy link
Collaborator

@mergenci I am in the process of re-writing the Upjet documentation to live on docs.upbound.io. During this I am fixing up links as needed. We can keep this issue open and close it once the documentation is published on docs.upbound.io.

@jeanduplessis
Copy link
Collaborator

With the donation of Upjet to the Crossplane project we will not be publishing documentation on docs.upbound.io anymore. We should address these reported broken links.

@jeanduplessis jeanduplessis added this to the 1.2 milestone Feb 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request is:triaged
Projects
None yet
Development

No branches or pull requests

2 participants