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

doc: quickstart for Go projects #3551

Merged
merged 6 commits into from
Aug 5, 2020
Merged

doc: quickstart for Go projects #3551

merged 6 commits into from
Aug 5, 2020

Conversation

camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Jul 26, 2020 •
edited
Loading

Description of the change:

  • The quickstart was moved to tutorial
  • Added new quickstart less verbose and with the concise steps.
  • Update the links and the order to show the docs
  • Update the pre-requirements and headers

See: https://deploy-preview-3551--operator-sdk.netlify.app/docs/building-operators/golang/quickstart/

Motivation for the change:

#3327

Closes for GO: #3590
Close: #3461

@camilamacedo86 camilamacedo86 requested review from anik120, estroz and hasbro17 and removed request for anik120 and estroz July 26, 2020 18:28
@joelanford joelanford mentioned this pull request Jul 26, 2020
Closed
92 tasks
@camilamacedo86 camilamacedo86 added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 27, 2020
@camilamacedo86 camilamacedo86 added this to the v1.0.0 milestone Jul 27, 2020
@camilamacedo86 camilamacedo86 added the language/go Issue is related to a Go operator project label Jul 27, 2020
@camilamacedo86 camilamacedo86 mentioned this pull request Jul 28, 2020
Closed
@anik120
Copy link
Contributor

anik120 commented Jul 28, 2020

Looks great @camilamacedo86. I'm guessing the same process is in the works for the Helm section too, but the golang and ansible sections' quickstart/tutorials looks great

joelanford
joelanford requested changes Jul 28, 2020
View reviewed changes
Copy link
Member

@joelanford joelanford left a comment

Choose a reason for hiding this comment

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

Looks good. I have mostly the same comments that I had in the Helm Quickstart PR.

#3552

website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
@openshift-ci-robot openshift-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 29, 2020
@camilamacedo86
Copy link
Contributor Author

Hi @joelanford all suggestions and made in the Helm PR are applied here.
It shows ok to be merged. Let me know what do you think.

@bharathi-tenneti
Copy link
Contributor

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 29, 2020
rashmigottipati
rashmigottipati approved these changes Jul 29, 2020
View reviewed changes
Copy link
Member

@rashmigottipati rashmigottipati left a comment

Choose a reason for hiding this comment

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

/lgtm

Just one nit

website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
joelanford
joelanford reviewed Jul 30, 2020
View reviewed changes
website/content/en/docs/building-operators/golang/quickstart.md Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/project_migration_guide.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/webhooks.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/webhooks.md Outdated Show resolved Hide resolved
@openshift-ci-robot openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 30, 2020
@camilamacedo86 camilamacedo86 mentioned this pull request Aug 3, 2020
Closed
@camilamacedo86 camilamacedo86 requested a review from estroz August 5, 2020 13:22
joelanford
joelanford requested changes Aug 5, 2020
View reviewed changes
Copy link
Member

@joelanford joelanford left a comment

Choose a reason for hiding this comment

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

Review for the envtest setup doc.

website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated Show resolved Hide resolved
joelanford
joelanford requested changes Aug 5, 2020
View reviewed changes
Copy link
Member

@joelanford joelanford left a comment

Choose a reason for hiding this comment

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

Review for Go quickstart.

website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/building-operators/golang/quickstart.md Outdated Show resolved Hide resolved
joelanford
joelanford approved these changes Aug 5, 2020
View reviewed changes
Copy link
Member

@joelanford joelanford left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 5, 2020
@camilamacedo86 camilamacedo86 merged commit 7e02962 into operator-framework:master Aug 5, 2020
@camilamacedo86 camilamacedo86 deleted the doc-qquick branch August 5, 2020 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rashmigottipati rashmigottipati rashmigottipati approved these changes

@joelanford joelanford joelanford approved these changes

@fabianvf fabianvf Awaiting requested review from fabianvf

@jmccormick2001 jmccormick2001 Awaiting requested review from jmccormick2001

@jmrodri jmrodri Awaiting requested review from jmrodri

@asmacdo asmacdo Awaiting requested review from asmacdo

@varshaprasad96 varshaprasad96 Awaiting requested review from varshaprasad96

@estroz estroz Awaiting requested review from estroz

Assignees

@joelanford joelanford

@rashmigottipati rashmigottipati

@bharathi-tenneti bharathi-tenneti

Labels
kind/documentation Categorizes issue or PR as related to documentation. language/go Issue is related to a Go operator project lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Milestone
v1.0.0
Development

Successfully merging this pull request may close these issues.

Kubebuilder is not listed in prerequisites
8 participants
@camilamacedo86 @anik120 @bharathi-tenneti @joelanford @rashmigottipati @estroz @varshaprasad96 @openshift-ci-robot