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

re-organize development.md #29945

Merged
merged 1 commit into from
Aug 17, 2016
Merged

re-organize development.md #29945

merged 1 commit into from
Aug 17, 2016

Conversation

mikebrow
Copy link
Member

@mikebrow mikebrow commented Aug 2, 2016

Addresses issue #13876; reorganizes and cleans up parts of development.md; splits out the godep section for managing vendor/ tree dependencies into a new godep.md file.

The developer guide has been reorganized to facilitate the majority of new developers working on Kubernetes.

Signed-off-by: Mike Brown brownwm@us.ibm.com


This change is Reviewable

@k8s-bot
Copy link

k8s-bot commented Aug 2, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in kubernetes/test-infra/jenkins/job-configs/kubernetes-jenkins-pull instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

@k8s-github-robot k8s-github-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. release-note-label-needed labels Aug 2, 2016
requirement that this doc does not capture, please file a bug. If you find
other docs with references to requirements that are not simply links to this
doc, please file a bug.
requirement that this doc does not capture, please submit an issue on github. If
Copy link
Contributor

Choose a reason for hiding this comment

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

linkify "submit an issue"?

Copy link
Member Author

@mikebrow mikebrow Aug 3, 2016

Choose a reason for hiding this comment

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

good idea... amended the commit. Cheers.

@brendandburns
Copy link
Contributor

@k8s-bot ok to test

@brendandburns
Copy link
Contributor

thanks! one minor request.

@brendandburns brendandburns added release-note-none Denotes a PR that doesn't merit a release note. and removed release-note-label-needed labels Aug 3, 2016
@brendandburns
Copy link
Contributor

Also, you need to run:

hack/update-munge-docs.sh

@mikebrow
Copy link
Member Author

mikebrow commented Aug 4, 2016

I did run update-mungedocs before commit and the commit checks did pass (the commit checks don't pass till you run it). When I run it I get the following output:

mike@mike-VirtualBox:~/go/src/k8s.io/kubernetes$ sudo hack/update-munge-docs.sh
[sudo] password for mike:
make: Entering directory '/home/mike/go/src/k8s.io/kubernetes'
make[1]: Entering directory '/home/mike/go/src/k8s.io/kubernetes'
I0804 09:51:24.789659 755 main.go:73] Completed successfully.
make[1]: Leaving directory '/home/mike/go/src/k8s.io/kubernetes'
Go version: go version go1.6.2 linux/amd64
+++ [0804 09:51:25] Generating bindata:
/home/mike/go/src/k8s.io/kubernetes/test/e2e/framework/gobindata_util.go
KUBE_ROOT not detected, setting default.
Generated bindata file : 11561 ../../..//test/e2e/generated/bindata.go lines of lovely automated artifacts
+++ [0804 09:51:27] Building the toolchain targets:
k8s.io/kubernetes/hack/cmd/teststale
+++ [0804 09:51:27] Building go targets for linux/amd64:
cmd/mungedocs
+++ [0804 09:51:27] Placing binaries
make: Leaving directory '/home/mike/go/src/k8s.io/kubernetes'
output: fatal: Not a valid object name upstream/release-1.3
,
ERROR: exit status 128
git ls-tree -r --name-only upstream/release-1.3 failed. We'll ignore this error locally, but Jenkins may pick an error. Munger uses the output of this command to determine in unversioned warning, if it should add a link to the doc in release branch. output: fatal: Not a valid object name upstream/release-1.3 , ERROR: exit status 128 git ls-tree -r --name-only upstream/release-1.3 failed. We'll ignore this error locally, but Jenkins may pick an error. Munger uses the output of this command to determine in unversioned warning, if it should add a link to the doc in release branch.
output: fatal: Not a valid object name upstream/release-1.3
,
ERROR: exit status 128
`git ls-tree -r --name-only upstream/release-1.3 failed. We'll ignore this error locally, but Jenkins may pick an error. Munger uses the output of this command to determine in unversioned warning, if it should add a link to the doc in release branch.

Thoughts?

@mikebrow
Copy link
Member Author

mikebrow commented Aug 4, 2016

Here's my git config ... am I missing an additional remote upstream?

remote.origin.url=https://github.com/mikebrow/kubernetes.git
remote.origin.fetch=+refs/heads/:refs/remotes/origin/
branch.master.remote=origin
branch.master.merge=refs/heads/master
remote.upstream.url=https://github.com/kubernetes/kubernetes.git
remote.upstream.fetch=+refs/heads/:refs/remotes/upstream/
branch.devel-tree-80col-updates-B.remote=origin
branch.devel-tree-80col-updates-B.merge=refs/heads/devel-tree-80col-updates-B

@mikebrow
Copy link
Member Author

mikebrow commented Aug 4, 2016

The command git ls-tree -r --name-only HEAD works but not git ls-tree -r --name-only upstream/release-1.3 as that is not a valid object name.

@k8s-github-robot k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 4, 2016
@mikebrow
Copy link
Member Author

mikebrow commented Aug 4, 2016

rebased

@k8s-github-robot k8s-github-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 4, 2016
@brendandburns
Copy link
Contributor

@david-mcmahon any ideas about the munge-docs error above?

@MHBauer
Copy link
Contributor

MHBauer commented Aug 8, 2016

I'm not sure it is correct for a script to assume there is a git remote named upstream. Is that documented somewhere?

@david-mcmahon
Copy link
Contributor

update-munge-docs was written with a dependency on a remote named upstream. I work around it myself with the release tooling. It may be 'fixable', but I never looked close enough. I suspect most people use the standard dev env and never encounter this.

@mikebrow
Copy link
Member Author

mikebrow commented Aug 8, 2016

Ok.. talked it over with @MHBauer I was using fetch on upstream master not upstream so I was not getting the extra tags or something.

@mikebrow
Copy link
Member Author

mikebrow commented Aug 8, 2016

rebased and re-ran hack/update-munge-docs.sh should be good to go now

godep v74 (linux/amd64/go1.6.2)
```

Developers planing to managing dependencies in the `vendor/` tree may want to
Copy link
Contributor

Choose a reason for hiding this comment

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

Planning has two 'n's. Unless we are flattening a surface.

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed thx.. I'm a woodworker :-)

@MHBauer
Copy link
Contributor

MHBauer commented Aug 8, 2016

I like the choice to get the godep details out of the fast path.

Signed-off-by: Mike Brown <brownwm@us.ibm.com>
@k8s-github-robot
Copy link

@ixdy
You must link to the test flake issue which caused you to request this manual re-test.
Re-test requests should be in the form of: k8s-bot test this issue: #<number>
Here is the list of open test flakes.

@brendandburns
Copy link
Contributor

LGTM

@k8s-bot e2e test this issue: #30454

@brendandburns brendandburns added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 11, 2016
@k8s-bot
Copy link

k8s-bot commented Aug 11, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in kubernetes/test-infra/jenkins/job-configs/kubernetes-jenkins-pull instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

@k8s-bot
Copy link

k8s-bot commented Aug 16, 2016

Can one of the admins verify that this patch is reasonable to test? If so, please reply "ok to test".
(Note: "add to whitelist" is no longer supported. Please update configurations in kubernetes/test-infra/jenkins/job-configs/kubernetes-jenkins-pull instead.)

This message may repeat a few times in short succession due to jenkinsci/ghprb-plugin#292. Sorry.

Otherwise, if this message is too spammy, please complain to ixdy.

@brendandburns
Copy link
Contributor

@k8s-bot ok to test
@k8s-bot unit test please issue: IGNORE

(looks like a general CI failure)

@k8s-bot
Copy link

k8s-bot commented Aug 17, 2016

GCE e2e build/test passed for commit 497c211.

@k8s-github-robot
Copy link

Automatic merge from submit-queue

@k8s-github-robot k8s-github-robot merged commit 361dd00 into kubernetes:master Aug 17, 2016
xingzhou pushed a commit to xingzhou/kubernetes that referenced this pull request Dec 15, 2016
Automatic merge from submit-queue

re-organize development.md 

Addresses issue kubernetes#13876; reorganizes and cleans up parts of development.md; splits out the godep section for managing `vendor/` tree dependencies into a new godep.md file.

```release-note
The developer guide has been reorganized to facilitate the majority of new developers working on Kubernetes.
```

Signed-off-by: Mike Brown <brownwm@us.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants