docs/contribution-guidelines: improve formatting, remove specifics of tests#3879
Conversation
openshift-ci-robot
added
the
kind/documentation
estroz
force-pushed
the
docs/remove-test-description
branch
3 times, most recently
from
6408aa2 to
c760f8a
Compare
| - `DOCKER_CLI_EXPERIMENTAL` set to `enabled` | ||
| - `COVERALLS_TOKEN` token to integrate the project with `https://coveralls.io/`. So, enable your fork in `https://coveralls.io/` and generate a token to allow it. | ||
| The operator-sdk repo uses [Travis CI][travis] to test each pull request and build images for both master commits | ||
| and releases. You can alter these processes by modifying this [`.travis.yml`][travis.yml] config file. |
There was a problem hiding this comment.
isn't this kind of weird advice? If i'm going to be maintaining a fork, i don't want to have a floating commit that I need to keep on top with my .travis.yaml changes, no?
There was a problem hiding this comment.
Why would you need a special commit for your fork? You are making these changes with the intent of them being in SDK master, so once that is done you ff your fork.
There was a problem hiding this comment.
Oh, I misunderstood what you meant by "You can alter these processes..."
| ## Continuous Integration (CI) | ||
|
|
||
| - `ANSIBLE_IMAGE` docker image name (e.g. `quay.io/joelanford/ansible-operator`) | ||
| - `HELM_IMAGE` same as above, but for helm | ||
| - `SCORECARD_PROXY_IMAGE` same as above, but for scorecard proxy | ||
| - `DOCKER_USERNAME` credentials for your repo | ||
| - `DOCKER_PASSWORD` credentials for your repo | ||
| - `DOCKER_CLI_EXPERIMENTAL` set to `enabled` | ||
| - `COVERALLS_TOKEN` token to integrate the project with `https://coveralls.io/`. So, enable your fork in `https://coveralls.io/` and generate a token to allow it. |
There was a problem hiding this comment.
How a collab will know how to set up the Travis in their fork if we are removing the info?
There was a problem hiding this comment.
These aren't being removed, see below.
There was a problem hiding this comment.
Sorry, I did not find where we are describing the ENV Vars that should be set in the fork travis. Could you please link it here?
There was a problem hiding this comment.
openshift-ci-robot
added
the
needs-rebase
estroz
force-pushed
the
docs/remove-test-description
branch
from
c760f8a to
04d700b
Compare
openshift-ci-robot
removed
the
needs-rebase
|
/lgtm |
5 participants
Description of the change:
Motivation for the change: these changes were made with the goal of simplifying contribution information, mainly removing test descriptions. These descriptions tend to drift because tests change often, so docs shouldn't discuss specifics of tests, only how to run them. This PR also fixes a broken link implicitly.
/kind documentation
Checklist
If the pull request includes user-facing changes, extra documentation is required:
changelog/fragments(seechangelog/fragments/00-template.yaml)website/content/en/docs