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.

Sign up for GitHub

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

Jump to bottom

Refactor the configuration guide #224

Merged
merged 1 commit into from
Jul 19, 2018
Merged

Refactor the configuration guide #224

merged 1 commit into from
Jul 19, 2018

Conversation

hogepodge
Copy link
Contributor

What this PR does / why we need it:
Refactoring of the configuration guide with the following features:

  • Added a table of contents for easier navigation.
  • Moved required and optional parameters into different sections.
  • Alphabetized groups and keys (excepting Global).
  • Replaces sample values with consistent placeholder text.

This is part of the effort to standardize documentation across
all cloud providers in collaboration with SIG-Cloud-Provider

Special notes for your reviewer:

This is a work in progress in collaboration with SIG-Cloud-Provider. Feedback from not just the OpenStack provider community, but other provider teams, is welcome.

Release note:

NONE

Refactor the configuration guide.
e967080 
Refactoring of the configuration guide with the following features:
* Added a table of contents for easier navigation.
* Moved required and optional parameters into different sections.
* Alphabetized groups and keys (excepting Global).

This is part of the effort to standardize documentation across
all cloud providers in collaboration with SIG-Cloud-Provider
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 3, 2018
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 3, 2018
@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 3, 2018

Build failed.

  • cloud-provider-openstack-acceptance-test-e2e-conformance-stable-branch-v1.10 : RETRY_LIMIT in 6s

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 3, 2018

Build succeeded.

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 3, 2018

Build succeeded.

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 3, 2018

Build succeeded.

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 3, 2018

Build succeeded.

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 3, 2018

Build succeeded.

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 3, 2018

Build succeeded.

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 3, 2018

Build succeeded.

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 3, 2018

Build failed.

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 4, 2018

Build succeeded.

@theopenlab-ci
Copy link

theopenlab-ci bot commented Jul 4, 2018

Build succeeded.

This was referenced Jul 5, 2018
Closed
Merged
@dims
Copy link
Member

dims commented Jul 10, 2018

/test cloud-provider-openstack-acceptance-test-flexvolume-cinder
/test cloud-provider-openstack-acceptance-test-e2e-conformance-stable-branch-v1.10

@dims
Copy link
Member

dims commented Jul 10, 2018

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dims

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 10, 2018
@hogepodge
Copy link
Contributor Author

/assign @dklyle

oomichi
oomichi reviewed Jul 17, 2018
View reviewed changes
docs/provider-configuration.md
---
title: OpenStack cloud provider options
---
# OpenStack Cloud Provider Configuration Options
Copy link
Member

Choose a reason for hiding this comment

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

How about renaming the file to docs/README.md instead?
This file seems a main file of this doc path and it is easy to read docs on github.com if the path contains README.md.

Copy link
Member

Choose a reason for hiding this comment

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

Oops, this PR is already approved I didn't find.
It is fine to consider this comment later.

dims
dims approved these changes Jul 17, 2018
View reviewed changes
Copy link
Member

@dims dims 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 "Looks good to me", indicates that a PR is ready to be merged. label Jul 17, 2018
@dims dims merged commit ce1a348 into kubernetes:master Jul 19, 2018
powellchristoph pushed a commit to powellchristoph/cloud-provider-openstack that referenced this pull request Jan 19, 2022
@dims
Merge pull request kubernetes#224 from hogepodge/refactor-configurati…
4d5d473 
…on-guide

Refactor the configuration guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oomichi oomichi oomichi left review comments

@dims dims dims approved these changes

@NickrenREN NickrenREN Awaiting requested review from NickrenREN

Assignees

@dims dims

@dklyle dklyle

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@hogepodge @dims @k8s-ci-robot @oomichi @dklyle