Add initial README docs. #47

bobcatfish · 2018-01-31T22:56:08Z

These docs are focused on how to start developing for Elafros.

We should probably aim to simplify this to just a couple of steps,
e.g. the k8s docs
(https://github.com/kubernetes/kubernetes#to-start-developing-kubernetes)
seem to make setup look like just a couple of commands (of course
they link to a lot of docs after the initial Go and Docker
configuration).

I've tried to make these docs very beginner friendly, which I think
is a good foot to start off on.

Fixes #28

mattmoor · 2018-01-31T23:01:29Z

sample/README.md

+1. [Setup your development environment](../DEVELOPMENT.md#getting-started)
+2. [Start Elafros](../README.md#start-elafros)
+
+## Running samples


I think we should have sample/README.md and a README.md per sample too.

kk, ill put the helloworld docs into their own README.md and link from here

mchmarny · 2018-01-31T23:02:37Z

LGTM. Given the different spots people can start from, would it make sense to split this into multiple docs? Probably longer term goal (Wiki?)

vaikas · 2018-01-31T23:09:16Z

DEVELOPMENT.md

+
+```shell
+$ mkdir -p ${GOPATH}/src/elafros
+$ git clone git@github.com:${YOUR_GITHUB_USERNAME}/elafros.git


Might want to say something here like;
git remote add upstream git@github.com:google/elafros.git
git remote set-url --push upstream no_push

So that git remote -v looks something like this:
vaikas@vaikas-linux3:~/projects/go/src/github.com/google/elafros$ git remote -v
origin git@github.com:vaikas-google/elafros.git (fetch)
origin git@github.com:vaikas-google/elafros.git (push)
upstream git@github.com:google/elafros.git (fetch)
upstream no_push (push)

I've found this super easy to keep fork up to date.
But others might know of a better way.
@mattmoor @grantr

I did:

go get github.com/google/elafros cd ${GOPATH}/src/github.com/google/elafros git remote rename origin upstream git remote add ${USER} github.com/${USER}/elafros

FWIW as-is what you have won't work, you need the github.com/google in the path.

seems to work just fine, I can fetch from upstream master, rebase and push to origin master and things are in sync.

Sounds good, added!

If you run: ./hack/update-deps.sh then dep will screw up all your deps.

@vaikas-google I mean ${GOPATH}/src/elafros, not what you have, which has the github.com part

vaikas · 2018-01-31T23:10:11Z

DEVELOPMENT.md

+### Iterating
+
+As you make changes to the code-base, there are two special cases to be aware of:
+* **If you change a type definition,** then you must run [`./hack/update-codegen.sh`](./hack/update-codegen.sh).


maybe explain what a type definition is (not a go type), but pkg/apis/ela/v1alpha1/... files

Added! Let me know if I was too specific though and you think there should be more of an explanation.

bobcatfish · 2018-01-31T23:14:09Z

LGTM. Given the different spots people can start from, would it make sense to split this into multiple docs? Probably longer term goal (Wiki?)

@mchmarny I would certainly love to see some docs somewhere re. how to setup a k8s cluster, since that could be a pretty big hurdle to new contributors

Personally I've had better experiences with docs in github rather than a wiki - with markdown (and even RST if you want to get really fancy) you can still have lots of simple docs that work well without a wiki - e.g. the k8s developer docs https://github.com/kubernetes/kubernetes#to-start-developing-kubernetes

bobcatfish · 2018-01-31T23:37:40Z

@mchmarny @vaikas-google @mattmoor PTAL

mattmoor · 2018-01-31T23:42:26Z

DEVELOPMENT.md

+repo](https://help.github.com/articles/fork-a-repo/), then:
+
+```shell
+mkdir -p ${GOPATH}/src/elafros


This path won't work, it must be ${GOPATH}/src/github.com/google/elafros.

Otherwise ./hack/update-deps.sh will have diffs :(

whoops, thanks, fixed!

mattmoor · 2018-01-31T23:45:35Z

sample/demo/helloworld/README.md

+1. [Setup your development environment](../DEVELOPMENT.md#getting-started)
+2. [Start Elafros](../README.md#start-elafros)
+
+## Running


Include a bit on cleaning up the demo?

okay done! i also changed the demo from googlecustomer to myhost

mattmoor · 2018-01-31T23:46:18Z

DEVELOPMENT.md

+Once the codegen and dependency information is correct, redeploying the controller is simply:
+```shell
+bazel run :controller.replace
+```


Should this talk about cleanup?

I've added a section in the main README about cleanup and linked to it here, let me know if that's not what you had in mind.

bobcatfish · 2018-01-31T23:56:35Z

README.md

+$ kubectl -n ela-system logs $(kubectl -n ela-system get pods -l app=ela-controller -o name)
+```
+
+## Clean up


@mattmoor I changed this section to work around bazelbuild/rules_k8s#97 but let me know if you'd rather I changed it back (or if it could be improved)

Does just running :elafros.delete work?

well it fails on the webhook delete, cuz of the ordering issue:

➜ elafros git:(28_initial_readme) bazel run :elafros.delete INFO: Analysed target //:elafros.delete (1 packages loaded). INFO: Found 1 target... Target //:elafros.delete up-to-date: bazel-bin/elafros.delete INFO: Elapsed time: 1.111s, Critical Path: 0.01s INFO: Build completed successfully, 4 total actions INFO: Running command line: bazel-bin/elafros.delete namespace "ela-system" deleted serviceaccount "ela-controller" deleted clusterrolebinding "ela-controller-admin" deleted customresourcedefinition "elaservices.elafros.dev" deleted customresourcedefinition "revisiontemplates.elafros.dev" deleted customresourcedefinition "revisions.elafros.dev" deleted deployment "ela-controller" deleted Error from server (NotFound): error when stopping "/usr/local/google/home/christiewilson/.cache/bazel/_bazel_christiewilson/585c8b345c232690c415b8f36dd1c661/execroot/elafros/bazel-out/k8-fastbuild/bin/elafros.delete.runfiles/elafros/webhook.yaml": deployments.extensions "ela-webhook" not found ERROR: Non-zero return code '1' from command: Process exited with status 1

so the options are:

run a simpler command that fails with a short error

run several commands that will not fail ?

i think you're leaning toward option 1, so we can go with that

okay section is updated @mattmoor

mattmoor · 2018-01-31T23:57:51Z

README.md

+bazel run :authz.delete
+bazel run :namespace.delete
+
+kubectl delete namespace istio-system


this seems like the wrong order?

yeah, also the istio delete does the namespace delete first thing so this is not needed

mattmoor · 2018-01-31T23:57:52Z

README.md

+$ kubectl -n ela-system logs $(kubectl -n ela-system get pods -l app=ela-controller -o name)
+```
+
+## Clean up


Does just running :elafros.delete work?

These docs are focused on how to start developing for Elafros. We should probably aim to simplify this to just a couple of steps, e.g. the k8s docs (https://github.com/kubernetes/kubernetes#to-start-developing-kubernetes) seem to make setup look like just a couple of commands (of course they link to a lot of docs after the initial Go and Docker configuration). I've tried to make these docs very beginner friendly, which I think is a good foot to start off on. Fixes #28

OLM manifests, including CatalogSource

/assign n3wscott

bobcatfish requested review from dewitt and mchmarny January 31, 2018 22:56

dewitt approved these changes Jan 31, 2018

View reviewed changes

mattmoor reviewed Jan 31, 2018

View reviewed changes

vaikas reviewed Jan 31, 2018

View reviewed changes

bobcatfish force-pushed the 28_initial_readme branch 3 times, most recently from f2dd049 to 4a22ae0 Compare January 31, 2018 23:24

bobcatfish mentioned this pull request Jan 31, 2018

Moved original demo to helloworld-demo and added thumbnailer demo #41

Merged

mattmoor reviewed Jan 31, 2018

View reviewed changes

bobcatfish force-pushed the 28_initial_readme branch from 4a22ae0 to 2d8a301 Compare January 31, 2018 23:44

mattmoor approved these changes Jan 31, 2018

View reviewed changes

vaikas approved these changes Jan 31, 2018

View reviewed changes

bobcatfish force-pushed the 28_initial_readme branch from 2d8a301 to 7f15124 Compare January 31, 2018 23:55

bobcatfish commented Jan 31, 2018

View reviewed changes

mattmoor reviewed Jan 31, 2018

View reviewed changes

bobcatfish force-pushed the 28_initial_readme branch 4 times, most recently from 8f056e7 to bfabd89 Compare February 1, 2018 00:14

bobcatfish force-pushed the 28_initial_readme branch from bfabd89 to 4b597bd Compare February 1, 2018 00:23

bobcatfish merged commit 790dec6 into knative:master Feb 1, 2018

bobcatfish deleted the 28_initial_readme branch February 1, 2018 01:01

mgencur pushed a commit to mgencur/serving-1 that referenced this pull request Apr 5, 2019

Merge pull request knative#47 from jcrossley3/SRVKS-39

f315def

OLM manifests, including CatalogSource

matzew pushed a commit to matzew/serving that referenced this pull request May 2, 2019

Merge pull request knative#47 from jcrossley3/SRVKS-39

173e41d

OLM manifests, including CatalogSource

tcnghia pushed a commit to tcnghia/serving that referenced this pull request Jun 8, 2020

Add an --upgrade flag to ./hack/update-deps.sh (knative#47)

6d68b6e

/assign n3wscott

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add initial README docs. #47

Add initial README docs. #47

bobcatfish commented Jan 31, 2018

mattmoor Jan 31, 2018

bobcatfish Jan 31, 2018

mchmarny commented Jan 31, 2018 •

edited

Loading

vaikas Jan 31, 2018

mattmoor Jan 31, 2018

mattmoor Jan 31, 2018

vaikas Jan 31, 2018

bobcatfish Jan 31, 2018

mattmoor Jan 31, 2018

mattmoor Jan 31, 2018

vaikas Jan 31, 2018

bobcatfish Jan 31, 2018

bobcatfish commented Jan 31, 2018

bobcatfish commented Jan 31, 2018

mattmoor Jan 31, 2018

bobcatfish Jan 31, 2018

mattmoor Jan 31, 2018

bobcatfish Feb 1, 2018

mattmoor Jan 31, 2018

bobcatfish Jan 31, 2018

bobcatfish Jan 31, 2018

mattmoor Jan 31, 2018

bobcatfish Feb 1, 2018

bobcatfish Feb 1, 2018

mattmoor Jan 31, 2018

bobcatfish Feb 1, 2018

mattmoor Jan 31, 2018

Add initial README docs. #47

Add initial README docs. #47

Conversation

bobcatfish commented Jan 31, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mchmarny commented Jan 31, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bobcatfish commented Jan 31, 2018

bobcatfish commented Jan 31, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mchmarny commented Jan 31, 2018 •

edited

Loading