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

I recently noticed that some links in the Shipwright documentation were pointing to 404 error pages. #128

Closed
wants to merge 1 commit into from

Conversation

shivamjaiswal424
Copy link

@shivamjaiswal424 shivamjaiswal424 commented Sep 14, 2024

I recently noticed that some links in the Shipwright documentation were pointing to 404 error pages, particularly in the sections for BuildStrategies and ClusterBuildStrategies. To resolve this issue, I made the following changes:

Updated the links to point to the correct files in the GitHub repository.
Ensured that both ClusterBuildStrategies and BuildStrategies sections now have accurate links to help users easily navigate to the relevant strategies.
For example, in the ClusterBuildStrategies section, I replaced the outdated relative links like ../samples/v1beta1/buildstrategy with the correct absolute links such as https://github.com/shipwright-io/build/tree/main/samples/v1beta1/buildstrategy.

This should make it easier for users to access the correct documentation without encountering broken links. Let me know if you have any questions or suggestions on further improvements!

Thanks,
Shivam Jaiswal

Changes

In the original doumentation of Shipwright it was difficult to find about the files of BuildStrategies and ClusterBuildStrategies.
I have added the correct links in their place.

Submitter Checklist

  • Includes tests if functionality changed/was added
  • Includes docs if changes are user-facing
  • Set a kind label on this PR
  • Release notes block has been filled in, or marked NONE

See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.

Release Notes

Bug fixes

@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 14, 2024
Copy link
Contributor

openshift-ci bot commented Sep 14, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign adambkaplan for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@shivamjaiswal424 shivamjaiswal424 changed the title Some links were pointing error 404 so I put the correct links in thei… I recently noticed that some links in the Shipwright documentation were pointing to 404 error pages. Sep 16, 2024
@adambkaplan
Copy link
Member

Apologies that we didn't get to this - it appears that we incorporated these changes in #140.

Thanks for pointing this out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants