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

Fix broken links for shipwright-io/build references #115

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

apoorvajagtap
Copy link
Member

@apoorvajagtap apoorvajagtap commented May 24, 2024

Changes

The buildstrategies.md references multiple examples of build/samples/v1beta1 directory. This PR copies the contents from the build/samples to the current project. This would aid the manual syncs (until we automate) in case of any new changes instead of updating the multiple links each time.

In addition to samples, references to controller.yaml are also updated to refer to the correct link per #113.

Follow up of #113

-->

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

Release Notes

NONE

@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 24, 2024
@apoorvajagtap
Copy link
Member Author

/assign @adambkaplan

@apoorvajagtap
Copy link
Member Author

/kind documentation

@openshift-ci openshift-ci bot added the kind/documentation Categorizes issue or PR as related to documentation. label May 24, 2024
Copy link

@avinal avinal left a comment

Choose a reason for hiding this comment

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

I see there are two types of changes, one for the broken links and the other is newly added YAMLs.

I would suggest breaking it into at least two commits clearly showing the specific change. Rest looks good to me.

@apoorvajagtap
Copy link
Member Author

I see there are two types of changes, one for the broken links and the other is newly added YAMLs.

I would suggest breaking it into at least two commits clearly showing the specific change. Rest looks good to me.

@avinal actually the addition of samples/ is done with the same intention of fixing the broken links (for example: https://github.com/shipwright-io/website/blob/main/content/en/docs/build/buildstrategies.md).

Copy link
Contributor

openshift-ci bot commented Aug 12, 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 ask for approval from adambkaplan. 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

@apoorvajagtap
Copy link
Member Author

I just realised, that the tests have been failing since my last push. I am currently working on it & shall push the changes soon.

@adambkaplan
Copy link
Member

Blocked by #127

Copy link
Member

Choose a reason for hiding this comment

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

@apoorvajagtap is there a reason why docsy is being updated here?

I also see a lot of other changes that go well beyond the scope of "fixing broken links" - can you explain this further in the body of your commit message?

Copy link

Choose a reason for hiding this comment

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

+1, docsy changes should be moved to a separate PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants