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.

Sign up for GitHub

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

Jump to bottom

Update docs #160

Merged
merged 1 commit into from
Feb 14, 2020
Merged

Update docs #160

merged 1 commit into from
Feb 14, 2020

Conversation

barney-s
Copy link
Contributor

@barney-s barney-s commented Feb 13, 2020 •
edited
Loading

Update docs

  • Add development guide
  • Add quickstart guide
  • Simplify Readme
  • Move api table from readme to api.md
  • Update contributing.md

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 13, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: barney-s

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 13, 2020
@barney-s
Copy link
Contributor Author

@nan-yu FYI

@barney-s barney-s changed the title Update contribution doc [WIP] Update contribution doc Feb 13, 2020
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 13, 2020
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 13, 2020
@barney-s barney-s changed the title [WIP] Update contribution doc Update contribution doc Feb 13, 2020
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 13, 2020
@barney-s
Copy link
Contributor Author

@nan-yu please review

@barney-s
Update docs
9b2748f 
- Add development guide
- Add quickstart guide
- Simplify Readme
- Move api table from readme to api.md
- Update contributing.md
@barney-s barney-s changed the title Update contribution doc Update docs Feb 14, 2020
@barney-s
Copy link
Contributor Author

/assign mortent
/assign janetkuo

ant31
ant31 suggested changes Feb 14, 2020
View reviewed changes
docs/examples/wordpress/application.yaml
@@ -27,11 +27,11 @@ spec:
type: "image/png"
size: "2000x680"
maintainers:
- name: Kenneth Owens
Copy link
Contributor

@ant31 ant31 Feb 14, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Fields(version, maintainers, icons....) are not nested under descriptor:, it's not an error introduced by this PR but it should be fixed.

edit:
opened a PR for it: #164 (I'll resolve conflict once this one is merged)

@barney-s
Copy link
Contributor Author

@ant31 would you please LGTM

@ant31
Copy link
Contributor

ant31 commented Feb 14, 2020

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 14, 2020
@k8s-ci-robot k8s-ci-robot merged commit 6322673 into kubernetes-sigs:master Feb 14, 2020
nan-yu
nan-yu reviewed Feb 14, 2020
View reviewed changes
Copy link
Contributor

@nan-yu nan-yu left a comment

Choose a reason for hiding this comment

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

Thanks @barney-s for updating the documentation! It is so well-organized now! Just a couple of comments 😉

docs/quickstart.md
Run locally
```bash
# create local cluster
make e2e-setup
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you forget to check in the e2e-setup and e2e-cleanup goals? I couldn't find them in the Makefile. @barney-s

Copy link
Contributor Author

Choose a reason for hiding this comment

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

its in the other CL pending merge #159

CONTRIBUTING.md
1. Regenerate the generated code using `kubebuilder generate`.
1. Update the [example](docs/examples/example.yaml)
This project uses and is built with [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder).
To regenerate code after changes to the [Application CRD](pkg/apis/app/v1beta1/application_types.go), run `make generate`. Typically `make all` would take care of it. Make sure you add enough [tests](pkg/apis/app/v1beta1/application_types_test.go). Update the [example](docs/examples/example.yaml)
Copy link
Contributor

Choose a reason for hiding this comment

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

The path has been changed to api/v1beta1/application_types.go

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry i didnt get time to fix it. Its merged will send another CL.

CONTRIBUTING.md Show resolved Hide resolved
docs/develop.md Show resolved Hide resolved
docs/develop.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
barney-s added a commit to barney-s/application that referenced this pull request Feb 15, 2020
@barney-s
Fix broken links
755cdb3 
Fix review comments from kubernetes-sigs#160
@barney-s barney-s mentioned this pull request Feb 15, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nan-yu nan-yu nan-yu left review comments

@ant31 ant31 ant31 approved these changes

@kow3ns kow3ns Awaiting requested review from kow3ns

@michelleN michelleN Awaiting requested review from michelleN

@mortent mortent Awaiting requested review from mortent

@janetkuo janetkuo Awaiting requested review from janetkuo

Assignees

@mortent mortent

@ant31 ant31

@janetkuo janetkuo

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@barney-s @k8s-ci-robot @ant31 @nan-yu @mortent @janetkuo