Skip to content

doc: quickstart for Go projects#3551

Merged
camilamacedo86 merged 6 commits intooperator-framework:masterfrom
camilamacedo86:doc-qquick
Aug 5, 2020
Merged

doc: quickstart for Go projects#3551
camilamacedo86 merged 6 commits intooperator-framework:masterfrom
camilamacedo86:doc-qquick

Conversation

@camilamacedo86
Copy link
Copy Markdown
Contributor

@camilamacedo86 camilamacedo86 commented Jul 26, 2020

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
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
Comment thread website/content/en/docs/building-operators/golang/webhooks.md Outdated
Comment thread website/content/en/docs/building-operators/golang/project_migration_guide.md Outdated
@anik120
Copy link
Copy Markdown
Member

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

Copy link
Copy Markdown
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

Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
@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
Copy Markdown
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
Copy Markdown
Contributor

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 29, 2020
Copy link
Copy Markdown
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

Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/project_migration_guide.md Outdated
Comment thread website/content/en/docs/building-operators/golang/webhooks.md Outdated
Comment thread website/content/en/docs/building-operators/golang/webhooks.md Outdated
@openshift-ci-robot openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 30, 2020
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
@camilamacedo86 camilamacedo86 requested a review from estroz August 5, 2020 13:22
Copy link
Copy Markdown
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.

Comment thread website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated
Comment thread website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated
Comment thread website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated
Comment thread website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated
Comment thread website/content/en/docs/building-operators/golang/references/env-test-setup.md Outdated
Copy link
Copy Markdown
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.

Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Comment thread website/content/en/docs/building-operators/golang/quickstart.md Outdated
Copy link
Copy Markdown
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

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

Development

Successfully merging this pull request may close these issues.

Kubebuilder is not listed in prerequisites

8 participants