Readme reorganize #669
Merged
Readme reorganize #669
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
qu1queee
added
do-not-merge/work-in-progress
openshift-ci-robot
added
the
release-note
zhangtbj
reviewed
Mar 17, 2021
openshift-ci-robot
added
the
needs-rebase
qu1queee
force-pushed
the
readme_reorganize
branch
from
4a3c3ae
to
93bec76
Compare
openshift-ci-robot
removed
the
needs-rebase
HeavyWombat
requested changes
Mar 23, 2021
qu1queee
force-pushed
the
readme_reorganize
branch
18 times, most recently
from
827f445
to
77e1987
Compare
Drives users on how to use Kaniko for building a container image.
Remove a Try It! section for buildstrategies docs, not longer needed. We have now a single Try It! in the main README
Doc that explains how to interact with the buildpacks stratey in order to build a container image.
qu1queee
force-pushed
the
readme_reorganize
branch
from
62d1236
to
67d5fdb
Compare
imjasonh
suggested changes
Mar 25, 2021
| apiVersion: shipwright.io/v1alpha1 | ||
| kind: BuildRun | ||
| metadata: | ||
| name: ruby-tutorial-buildrun |
There was a problem hiding this comment.
Suggested change
| name: ruby-tutorial-buildrun | |
| generateName: ruby-tutorial-buildrun- |
| apiVersion: shipwright.io/v1alpha1 | ||
| kind: BuildRun | ||
| metadata: | ||
| name: go-tutorial-buildrun |
There was a problem hiding this comment.
Suggested change
| name: go-tutorial-buildrun | |
| generateName: go-tutorial-buildrun- |
There was a problem hiding this comment.
This was on purpose, otherwise it complicates the usage of kubectl get buildrun go-tutorial-buildrun -o json | jq '.status.conditions[]' command.
imjasonh
reviewed
Mar 25, 2021
HeavyWombat
requested changes
Mar 25, 2021
docs/tutorials/tutorial.md
Outdated
| | **`Strategy`** | Refers to a particular tool that will be used when building a container image, such as Kaniko, Buildah, ko, etc. | | ||
| | **`Build`** | Resource used to define a build configuration. | | ||
| | **`BuildRun`** | Resource used to start the image build mechanism. | | ||
| | **`BuildStrategy/ClusterBuildStrategy`** | Resource that holds a template that dictates how to build via a particular strategy. | |
There was a problem hiding this comment.
Suggested change
| | **`BuildStrategy/ClusterBuildStrategy`** | Resource that holds a template that dictates how to build via a particular strategy. | | |
| | **`BuildStrategy/ClusterBuildStrategy`** | Resource that holds a template that describes how to build via a particular strategy. | |
SaschaSchwarze0
requested changes
Mar 29, 2021
Co-authored-by: Jason Hall <[email protected]> Co-authored-by: Matthias Diester <[email protected]> Co-authored-by: Sascha Schwarze <[email protected]>
Co-authored-by: Jason Hall <[email protected]>
qu1queee
force-pushed
the
readme_reorganize
branch
from
e85ab74
to
81bd4ab
Compare
qu1queee
force-pushed
the
readme_reorganize
branch
2 times, most recently
from
0585fa4
to
5f1c042
Compare
|
/approve |
openshift-ci-robot
added
the
approved
Rename tutorial.md to README.md When listing strategies, follow an order of prio, based on Other minor enhance around versions.
qu1queee
force-pushed
the
readme_reorganize
branch
from
5f1c042
to
7688e4f
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: SaschaSchwarze0 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 |
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Fixes #655
Note: Opening this PR for feedback on the ongoing efforts to improve our README and to understand what other issues we might require to make this ready. The current state of this PR is:
Shipwright - a framework for building container images on KubernetesintoShipwrightWhy?section.Try It!section. @zhangtbj you can take some ideas of this one and leverage your current PR.Please tell me more!section. This one still incomplete. We will require new documents to properly provide more information for users that already try it, and that are looking forward to understand what else they can do. For example, how to build with Kaniko, or other strategies.More informationsection. This one still incomplete. Here we want to add all existing information around dependencies, existing documentation links, etc. We assume that a user that is at this block, might be willing to contribute eventually, therefore the need of providing as much context as possible before jumping into contributions or similar.Want to get involved?section. This one is only reusing the existing information we have already in this file.Submitter Checklist
See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.
Release Notes