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

docs: update helm docs for the new layout #3326

Merged

Conversation

camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Jul 1, 2020

Description of the change:

Provide the same documentation and steps using the helm plugin. See the PR #3421 which adds the plugin.

  • Update all related info in the Helm documentation
  • Create a new sub-directory called Legacy to keep the previous docs

Motivation

SDK is in a process to be integrated with KB which means that its project layouts will be aligned. More info : Integrating Kubebuilder and Operator SDK and Extensible CLI and Scaffolding Plugins.

@camilamacedo86 camilamacedo86 changed the title docs: update helm docs for the new layout WIP: docs: update helm docs for the new layout Jul 1, 2020
@openshift-ci-robot openshift-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 Jul 1, 2020
@camilamacedo86 camilamacedo86 force-pushed the helm-plugin-doc branch 3 times, most recently from 7bd4d1c to b458219 Compare July 1, 2020 20:35
@camilamacedo86 camilamacedo86 changed the title WIP: docs: update helm docs for the new layout docs: update helm docs for the new layout Jul 1, 2020
@openshift-ci-robot openshift-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 Jul 1, 2020
@camilamacedo86 camilamacedo86 added language/helm Issue is related to a Helm operator project kind/documentation Categorizes issue or PR as related to documentation. kubebuilder-integration Relates to rewriting the SDK in Kubebuilder plugin form labels Jul 1, 2020
@openshift-ci-robot openshift-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 3, 2020
@camilamacedo86 camilamacedo86 added blocked and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jul 3, 2020
camilamacedo86 added a commit to camilamacedo86/operator-sdk that referenced this pull request Jul 8, 2020
…t public to users


Removed the header for we are able to merge this doc without making it public to users and then, make it visible in the PR operator-framework#3326
camilamacedo86 added a commit that referenced this pull request Jul 8, 2020
…#3342)

**Description of the change:**
- Add doc with the steps required that need is followed by the users migrate their project for the new layout. 
IMPORTANT: It is not visible on the website. The follow-up PR #3326 will make it visible. 

**Motivation for the change:**
SDK is in a process to be integrated with KB which means that its project layouts will be aligned. More info : [Integrating Kubebuilder and Operator SDK](https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/integrating-kubebuilder-and-osdk.md). 

As part of this process, we are creating the Helm plugin. See PR #3295. Also, we are updating the steps in the doc in the PR #3326 and here we are adding a new doc which will help users to migrate their projects.
@camilamacedo86 camilamacedo86 force-pushed the helm-plugin-doc branch 2 times, most recently from a93d1f0 to b563841 Compare July 9, 2020 14:18
@camilamacedo86
Copy link
Contributor Author

camilamacedo86 commented Jul 16, 2020

Hi @joelanford,

All suggestions are applied. To make it easier has just 5 comments that I think you need to re-check and let us know if are they ok for you. They are: #3326 (comment), #3326 (comment), #3326 (comment), #3326 (comment), #3326 (comment).

website/content/en/docs/helm/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/helm/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/helm/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/helm/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/helm/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/helm/quickstart.md Outdated Show resolved Hide resolved
website/content/en/docs/helm/reference/scaffolding.md Outdated Show resolved Hide resolved
@camilamacedo86 camilamacedo86 force-pushed the helm-plugin-doc branch 4 times, most recently from c1738f7 to f0854bb Compare July 16, 2020 17:50
@camilamacedo86
Copy link
Contributor Author

Applied all suggestions + I re-due a re-check as well. I think it is good now.

@joelanford
Copy link
Member

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 17, 2020
Copy link
Contributor

@bharathi-tenneti bharathi-tenneti left a comment

Choose a reason for hiding this comment

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

/lgtm

Copy link
Member

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

New changes are detected. LGTM label has been removed.

@camilamacedo86 camilamacedo86 merged commit a5daa91 into operator-framework:master Jul 18, 2020
@camilamacedo86 camilamacedo86 deleted the helm-plugin-doc branch July 18, 2020 00:34
camilamacedo86 added a commit to camilamacedo86/operator-sdk that referenced this pull request Jul 19, 2020
**Description of the change:**

Provide the same documentation and steps using the helm plugin. See the PR operator-framework#3421 which adds the plugin. 

- Update all related info in the Helm documentation  
- Create a new sub-directory called Legacy to keep the previous docs

**Motivation**

SDK is in a process to be integrated with KB which means that its project layouts will be aligned. More info : [Integrating Kubebuilder and Operator SDK](https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/integrating-kubebuilder-and-osdk.md) and [Extensible CLI and Scaffolding Plugins](https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/extensible-cli-and-scaffolding-plugins-phase-1.md).
@jianzhangbjz
Copy link
Contributor

/lgtm

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. kubebuilder-integration Relates to rewriting the SDK in Kubebuilder plugin form language/helm Issue is related to a Helm operator project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants