Skip to content
This repository has been archived by the owner on Feb 22, 2022. It is now read-only.

[stable/jenkins] Reorder README parameters into sections for readability #22782

Merged
merged 16 commits into from
Jul 19, 2020

Conversation

wmcdona89
Copy link
Collaborator

What this PR does / why we need it:

Reorder parameters in README to facilitate chart usage and maintenance.

Which issue this PR fixes

(optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close that issue when PR gets merged)

  • fixes #

Special notes for your reviewer:

There are a series of commits to facilitate the review. values.yaml could also be reordered.

Checklist

[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]

  • DCO signed
  • Chart Version bumped
  • Variables are documented in the README.md
  • Title of the PR starts with chart name (e.g. [stable/mychartname])

@helm-bot helm-bot added Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 14, 2020
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 14, 2020
@wmcdona89
Copy link
Collaborator Author

/assign @torstenwalter

@wmcdona89
Copy link
Collaborator Author

/retest

Copy link
Collaborator

@torstenwalter torstenwalter left a comment

Choose a reason for hiding this comment

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

@wmcdona89 Thanks for suggesting this! It looks really good! One idea would be to split the table into multiple ones and use section titles as subheadings or keep it in one table and make those bold?

@scottrigby
Copy link
Member

Testing infra was fixed, so last failure shouldn't happen again
/retest

@scottrigby
Copy link
Member

Try retest after resolving merge conflict

@stale
Copy link

stale bot commented Jul 18, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Any further update will cause the issue/pull request to no longer be considered stale. Thank you for your contributions.

@stale stale bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 18, 2020
@helm-bot helm-bot removed the Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). label Jul 19, 2020
@stale stale bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 19, 2020
@helm-bot helm-bot added the Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). label Jul 19, 2020
wmcdona89 added 10 commits July 18, 2020 23:05
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
@helm-bot helm-bot removed the Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). label Jul 19, 2020
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
@helm-bot helm-bot added the Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). label Jul 19, 2020
@wmcdona89
Copy link
Collaborator Author

@torstenwalter this is ready for another review

Copy link
Collaborator

@torstenwalter torstenwalter left a comment

Choose a reason for hiding this comment

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

/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: torstenwalter, wmcdona89

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@wmcdona89
Copy link
Collaborator Author

/retest

@k8s-ci-robot k8s-ci-robot merged commit 1e06c7e into helm:master Jul 19, 2020
includerandom pushed a commit to includerandom/helm_charts that referenced this pull request Jul 19, 2020
…ity (helm#22782)

* [stable/jenkins] Reorder README parameters into sections for readability

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Chart's Primary Parameters

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration Files & Scripts

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Deployment & Service

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Secret

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Security

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Settings

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins In-Process Script Approval

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Plugins

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Kubernetes Plugin

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Top-Level Agent Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Pod Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Side Container Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* split sections into separate tables

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration as Code

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Deprecated

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
KinsheX pushed a commit to KinsheX/charts that referenced this pull request Jul 20, 2020
…ity (helm#22782)

* [stable/jenkins] Reorder README parameters into sections for readability

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Chart's Primary Parameters

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration Files & Scripts

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Deployment & Service

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Secret

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Security

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Settings

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins In-Process Script Approval

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Plugins

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Kubernetes Plugin

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Top-Level Agent Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Pod Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Side Container Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* split sections into separate tables

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration as Code

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Deprecated

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
li-adrienloiseau pushed a commit to li-adrienloiseau/charts that referenced this pull request Jul 29, 2020
…ity (helm#22782)

* [stable/jenkins] Reorder README parameters into sections for readability

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Chart's Primary Parameters

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration Files & Scripts

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Deployment & Service

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Secret

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Security

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Settings

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins In-Process Script Approval

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Plugins

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Kubernetes Plugin

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Top-Level Agent Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Pod Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Side Container Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* split sections into separate tables

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration as Code

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Deprecated

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Adrien Loiseau <adrien.loiseau@logic-immo.com>
mmingorance-dh pushed a commit to mmingorance-dh/charts that referenced this pull request Aug 28, 2020
…ity (helm#22782)

* [stable/jenkins] Reorder README parameters into sections for readability

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Chart's Primary Parameters

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration Files & Scripts

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Deployment & Service

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Secret

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Security

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Settings

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins In-Process Script Approval

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Plugins

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Kubernetes Plugin

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Top-Level Agent Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Pod Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Side Container Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* split sections into separate tables

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration as Code

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Deprecated

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Signed-off-by: Miguel Mingorance <miguel.mingorance@deliveryhero.com>
wmcdona89 added a commit to wmcdona89/charts that referenced this pull request Aug 30, 2020
…ity (helm#22782)

* [stable/jenkins] Reorder README parameters into sections for readability

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Chart's Primary Parameters

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration Files & Scripts

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Deployment & Service

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Kubernetes Secret

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Security

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Global Settings

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins In-Process Script Approval

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Plugins

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Kubernetes Plugin

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Top-Level Agent Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Pod Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Agent Side Container Configuration

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* split sections into separate tables

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Jenkins Configuration as Code

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>

* Deprecated

Signed-off-by: Aaron McDonald <wmcdona89@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. Contribution Allowed If the contributor has signed the DCO or the CNCF CLA (prior to the move to a DCO). lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants