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

Improve Documentation for build and buildRun #848

Merged

Conversation

dalbar
Copy link
Member

@dalbar dalbar commented Aug 5, 2021

Changes

Fixes #847

Modified example in build.md that should illustrate the revision property and fixed relative paths to build and buildRun config for buildstrategies.md.

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

Fixed documentation for build and buildStrategies

We should make sure that examples in the documentation for the build CDR have
correct examples regarding the properties that the want to illustrate and that
links to samples are kept up-to-date.

Modified example in `build.md` that should illustrate the revision property and
fixed relative paths to build and buildRun config for `buildstrategies.md`.
@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Aug 5, 2021
@dalbar dalbar marked this pull request as ready for review August 5, 2021 17:09
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 5, 2021
@dalbar
Copy link
Member Author

dalbar commented Aug 5, 2021

/assign @HeavyWombat

@openshift-ci openshift-ci bot added release-note Label for when a PR has specified a release note lgtm Indicates that a PR is ready to be merged. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Aug 5, 2021
Copy link
Contributor

@HeavyWombat HeavyWombat left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 5, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: HeavyWombat

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

The pull request process is described 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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 5, 2021
@openshift-ci openshift-ci bot merged commit 06c5082 into shipwright-io:main Aug 5, 2021
@adambkaplan adambkaplan added this to the release-v0.6.0 milestone Oct 6, 2021
@dalbar dalbar deleted the fix/documentation-build-buildRun branch October 20, 2021 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. release-note Label for when a PR has specified a release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation for the build and buildRun CRD
3 participants