Refine the document for getting start

[zhangtbj]

For requirement: https://kubernetes.slack.com/archives/C019ZRGUEJC/p1600182959018100

• Add Want to contribute block more in the main README
• Add more install and deployment related info in deploying.md
• Change deploying.md to the DEVELOPMENT.md
• Remove the Features block in the main README because it is already out-of-date

[SaschaSchwarze0]

The DEVELOPMENT.MD file is a copy from Tekton Pipelines, https://github.com/tektoncd/pipeline/blob/master/DEVELOPMENT.md plus adjustments for the build project. Please make appropriate changes to the copyright header of the file to comply with article 4 of the Apache License.

[zhangtbj]

Hi Sascha,

What should I add in the header?

I also view other DEVELOPMENT.md, some of them are similar, such as knative/serving md:
https://github.com/knative/serving/blob/master/DEVELOPMENT.md

They all follow the similar way.

I am not sure if we also need to add the other license for the md format?

[SaschaSchwarze0]

Hi Sascha,

What should I add in the header?

I also view other DEVELOPMENT.md, some of them are similar, such as knative/serving md:
https://github.com/knative/serving/blob/master/DEVELOPMENT.md

They all follow the similar way.

I am not sure if we also need to add the other license for the md format?

I would change the file header to:

<!--
Copyright 2018, 2020 The Tekton Authors
Copyright The Shipwright Contributors

SPDX-License-Identifier: Apache-2.0

Documentation inspired from https://github.com/tektoncd/pipeline/blob/ce7591acec8a6aa726d88e5cc057588665881ace/DEVELOPMENT.md
-->

[adambkaplan]

This is a great start and has a lot of good details that are missing in the existing docs.

I think with this and HACK.md we have two overlapping documents that IMO should target different audiences.

Others should weigh in, personally I'd like to see the following:

1. A "Getting Started" guide to target an end-user who does not want to build from source. Perhaps we can simplify matters and assume the end user knows what Kubernetes is and has access to a cluster. The goal is to provide instructions on how to install Shipwright, create a Build, and start a BuildRun.
2. A "Hacking" guide to target contributors - instructions on how to compile, test the operator locally, deploy your hacked version on a cluster, etc.

[zhangtbj]

Hi Sascha,

I also correct the Copyright

[adambkaplan]

I would try to be a bit more neutral here:

Suggested change

	1. Set up a docker repository for pushing images. You can use any container
	image registry by adjusting the authentication methods and repository paths
	mentioned in the sections below.
	- [Docker Hub quickstart](https://docs.docker.com/docker-hub/)
	- [IBM Container Registry quickstart](https://cloud.ibm.com/docs/Registry)
	1. Set up a container image repository for pushing images. Any container image registry that is accessible to your cluster can be used for your repository. This can be a public registry like [Docker Hub])(https://docs.docker.com/docker-hub/), [quay.io](https://quay.io), or a container registry run by your cloud provider.

[zhangtbj]

Sure thing. Done

[zhangtbj]

Hi @SaschaSchwarze0 , @adambkaplan or all,

Do you have any suggestions?

If no other suggestion, I will go ahead to merge this PR.

Thanks!

[SaschaSchwarze0]

Hi, you just mentioned me. Please be aware that I am on vacation and come back October 5th.

[qu1queee]

/lgtm

[qu1queee]

/approve

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qu1queee

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:

• OWNERS [qu1queee]

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