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

Updated bucket-class and backing-store MD docs #113

Merged
merged 1 commit into from Nov 11, 2019

Conversation

jeniawhite
Copy link
Contributor

Added examples and updated the documentation to be relevant to the code.
Related issues:
#98
#106
#107

doc/backing-store-crd.md Outdated Show resolved Hide resolved
doc/backing-store-crd.md Outdated Show resolved Hide resolved
doc/bucket-class-crd.md Outdated Show resolved Hide resolved
@jeniawhite
Copy link
Contributor Author

@ron1
I've made the changes.
Thank you for your feedback.

@jeniawhite
Copy link
Contributor Author

@ron1
I've updated the "(Note)" section.
Sorry for the misunderstanding.
Do you have any other suggestions or is this PR good to go?

@ron1
Copy link

ron1 commented Oct 30, 2019

@ron1
I've updated the "(Note)" section.
Sorry for the misunderstanding.
Do you have any other suggestions or is this PR good to go?

Just a few more comments included below. Otherwise, /lgtm

  1. Use namespace noobaa in the examples to be consistent with the cli defaults and the noobaa CRD here: https://github.com/noobaa/noobaa-operator/blob/20686e8b563825d29e27f8f49add6b1577a9b629/doc/noobaa-crd.md#status

  2. Use backing-store names bs or bs[1-9] and bucket-class names bc or bc[1-9] in the examples for clarity.

doc/bucket-class-crd.md Outdated Show resolved Hide resolved
@jeniawhite jeniawhite force-pushed the evgb-Documentation branch 2 times, most recently from 023f3a5 to 4377a6e Compare October 31, 2019 09:53
@jeniawhite
Copy link
Contributor Author

@ron1 @bipuladh
Updated the docs.
Please take a look and tell me if I can merge.
Thank you.

@guymguym
Copy link
Member

@jeniawhite Please rebase

doc/backing-store-crd.md Outdated Show resolved Hide resolved
doc/backing-store-crd.md Outdated Show resolved Hide resolved
doc/backing-store-crd.md Show resolved Hide resolved
doc/backing-store-crd.md Outdated Show resolved Hide resolved
doc/backing-store-crd.md Outdated Show resolved Hide resolved
doc/backing-store-crd.md Outdated Show resolved Hide resolved
doc/backing-store-crd.md Outdated Show resolved Hide resolved
doc/backing-store-crd.md Outdated Show resolved Hide resolved
doc/bucket-class-crd.md Outdated Show resolved Hide resolved
doc/backing-store-crd.md Outdated Show resolved Hide resolved
@jeniawhite jeniawhite force-pushed the evgb-Documentation branch 2 times, most recently from 8422348 to cc1d0e2 Compare November 4, 2019 22:57
@jeniawhite
Copy link
Contributor Author

@guymguym @nimrod-becker
Updated docs.

@jeniawhite jeniawhite force-pushed the evgb-Documentation branch 3 times, most recently from 258fdb9 to 199bcb0 Compare November 10, 2019 17:22
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.

None yet

6 participants