Skip to content

WIP: update multi-tenacy docs#1

Open
davidblum wants to merge 1 commit intomainfrom
multi-tenancy-docs
Open

WIP: update multi-tenacy docs#1
davidblum wants to merge 1 commit intomainfrom
multi-tenancy-docs

Conversation

@davidblum
Copy link
Copy Markdown
Owner

This PR updates the multi-tenancy section to provide:

  • syntax fixes
  • more explanation around components
  • an applyable example

/kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Checklist:

  • squashed commits
  • includes documentation
  • adds unit tests
  • adds or updates e2e tests

Release note:


Comment thread docs/book/src/topics/multitenancy.md Outdated
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I believe this might be redundant, the identityRef has nothing to do with the account per se, and the paragraph at line 24 clarify what is this about.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

I understand the point you're making. I think while it may be redundant, it states an important part of the multi-tenancy configuration. Which is how an operator dictates which cluster they can deploy into.

I'd like to leave something high level explaining this at the top of the doc, do you have any suggestions for wording?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

You could say something like:

identityRef reference the credentials or the role that the capa-controller will use to manage the relative cluster

But then we are, sort of, repeating what's in the previous paragraph

Comment thread docs/book/src/topics/multitenancy.md Outdated
Comment thread docs/book/src/topics/multitenancy.md Outdated
@LucaLanziani
Copy link
Copy Markdown

Aside from the comment above, LGTM

@davidblum davidblum force-pushed the multi-tenancy-docs branch from 6cf67b8 to 64d6f82 Compare March 16, 2022 16:45
typo

CR feedback
@davidblum davidblum force-pushed the multi-tenancy-docs branch from 1b05e5c to 4048a8d Compare March 23, 2022 16:48
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.

2 participants