Skip to content

Conversation

rjeberhard
Copy link
Member

No description provided.

Longer running feature work will be performed on specific branches, such as ```feature/dynamic-clusters```. Since we want
to balance separating destabilizing work into feature branches against the possibility of later difficult merges, we
encourage developers working on features to pull out any necessary refactoring or improvements that are general purpose into
their own shorter-lived branches and create pull requests to ```develop``` when these smaller work items are complete.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo, are complete, should be are completed.


You can build, test, and publish the Docker image for the operator directly from Wercker using the ```wercker.yml``` from this repository.

If you haven't done so already, navigate to [wercker.com](https://www.wercker.com) and create an account. Once you are logged in,
Copy link
Contributor

Choose a reason for hiding this comment

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

Once you are logged in, should be After you are logged in.

You can build, test, and publish the Docker image for the operator directly from Wercker using the ```wercker.yml``` from this repository.

If you haven't done so already, navigate to [wercker.com](https://www.wercker.com) and create an account. Once you are logged in,
on the [app.wercker.com] (https://app.wercker.com) page press, "Create your first application."
Copy link
Contributor

Choose a reason for hiding this comment

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

"press", should be "click"

If you haven't done so already, navigate to [wercker.com](https://www.wercker.com) and create an account. Once you are logged in,
on the [app.wercker.com] (https://app.wercker.com) page press, "Create your first application."

Select GitHub (the default, if you are new to Wercker). If you haven't done so already, press the "Connect" button within the
Copy link
Contributor

Choose a reason for hiding this comment

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

"press", should be "click"


Select GitHub (the default, if you are new to Wercker). If you haven't done so already, press the "Connect" button within the
larger GitHub button and follow the prompts to provide a login for GitHub. This connects your Wercker and GitHub accounts so
that Wercker pipelines will later be able to clone this repository. Press, "Next."
Copy link
Contributor

Choose a reason for hiding this comment

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

"press", should be "click" globally.


Verify the settings so far on the review page and press, "Create."

Since this GitHub repository already has a ```wercker.yml``` file, you can skip directly to the "Environment" tab.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Since", should be "Because"

| REPO_PASSWORD | Password for registry | Use generated SWIFT password |
| IMAGE_TAG_OPERATOR | Image tag, such as 0.2 or latest | |

Select the "Runs" tab. Skip to the bottom and press, "Trigger your first build now."
Copy link
Contributor

Choose a reason for hiding this comment

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

"Skip" should be "Scroll"

## Build the Docker image for the operator locally

The following software are required to obtain and build the operator:

Copy link
Contributor

Choose a reason for hiding this comment

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

"The following software are required" should be "The following software is required"

@mriccell mriccell requested a review from markxnelson April 30, 2018 12:51
their own shorter-lived branches and create pull requests to ```develop``` when these smaller work items are complete.

When it is time for a release, we will branch off ```develop``` to create a per-release branch. Here, we will update version
numbers, rebuild javadoc, if necessary, and perform any other pre-release updates. Finally, this release branch will be merged
Copy link
Member

Choose a reason for hiding this comment

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

"numbers, rebuild javadocs, if necessary" should it not be "numbers, rebuild javadocs if necessary, and"

[comment]: # ( In this command, replace the uppercase items with the appropriate values. The `SECRET_NAME` will be needed in later parameter files. The `NAMESPACE` must match the namespace where the operator will be deployed. )

## Build the Docker image for the operator
## Build the Docker image for the operator using Wercker
Copy link
Member

Choose a reason for hiding this comment

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

Ryan not sure if the "Build the Docker image for the operator using Wercker" should not go immediately after "Build the Docker image for the operator locally" since this section includes requirements for the Operator image.

Copy link
Member Author

Choose a reason for hiding this comment

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

@mriccell But, you don't need to meet any of these requirements to build using Wercker, since the customer will get a box from Wercker's quota and the wrecker.yml ensures that the requirements (java, maven) are satisfied.

@mriccell mriccell requested a review from moreaut May 1, 2018 15:50
@mriccell mriccell merged commit c13996a into develop May 1, 2018
@rjeberhard rjeberhard deleted the doc-branching branch May 10, 2018 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants