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

Introduce persona-based docs #641

Merged
merged 1 commit into from
Aug 11, 2023
Merged

Introduce persona-based docs #641

merged 1 commit into from
Aug 11, 2023

Conversation

vlerenc
Copy link
Member

@vlerenc vlerenc commented Jul 1, 2023 •
edited
Loading

What this PR does / why we need it:
We would like to introduce persona-based docs focussing on the already known release notes personas:

  • users
  • operators
  • developers

Special notes for your reviewer:
@n-boshnakov Can you please share your thoughts?
@shreyas-s-rao We agreed not to change too much (maybe anything), but I thought, maybe we can prepare some basics already, so that you have a better starting point later. Anyway, please check whether the small change is OK for you. Thanks in advance.

Release note:
None as ~30 PRs have/will be opened and the message would be the same everywhere.

@vlerenc vlerenc requested a review from a team as a code owner July 1, 2023 04:39
@gardener-robot gardener-robot added needs/review Needs review size/s Size of pull request is small (see gardener-robot robot/bots/size.py) labels Jul 1, 2023
@vlerenc vlerenc requested a review from n-boshnakov July 1, 2023 04:39
@gardener-robot-ci-2 gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Jul 1, 2023
@gardener-robot-ci-1 gardener-robot-ci-1 added needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Jul 1, 2023
@n-boshnakov
Copy link

Just a note, but the newly created manifest will need to also be added to one of the gardener/documentation manifests (probably in other-components.yaml) before it can appear on the website.

@gardener-robot
Copy link

@n-boshnakov You have pull request review open invite, please check

@n-boshnakov n-boshnakov mentioned this pull request Jul 4, 2023
Closed
@vlerenc vlerenc mentioned this pull request Jul 5, 2023
Merged
@vlerenc
Copy link
Member Author

vlerenc commented Jul 5, 2023

Thanks @n-boshnakov, I added this component there.

Are the etcd backup&restore maintainers otherwise OK to review the PR?

@n-boshnakov
Copy link

Thanks @n-boshnakov, I added this component there.

Are the etcd backup&restore maintainers otherwise OK to review the PR?

Yes, they can review the PR.

@vlerenc
Copy link
Member Author

vlerenc commented Jul 8, 2023

Is it OK to merge this PR (cc @shreyas-s-rao)?

ishan16696
ishan16696 reviewed Jul 30, 2023
View reviewed changes
.docforge/manifest.yaml Outdated Show resolved Hide resolved
@shreyas-s-rao shreyas-s-rao self-assigned this Aug 7, 2023
@shreyas-s-rao shreyas-s-rao added this to the v0.26.0 milestone Aug 7, 2023
shreyas-s-rao
shreyas-s-rao approved these changes Aug 8, 2023
View reviewed changes
Copy link
Collaborator

@shreyas-s-rao shreyas-s-rao left a comment

Choose a reason for hiding this comment

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

@vlerenc thanks a lot for taking the time to restructure the docs section. There are many more changes required with respect to the content of these docs, but this PR sets up the correct format/file structure to make those changes.

Other than one small nit, LGTM.
/lgtm

.docforge/manifest.yaml Outdated Show resolved Hide resolved
@gardener-robot gardener-robot added reviewed/lgtm Has approval for merging and removed needs/review Needs review labels Aug 8, 2023
@gardener-robot-ci-3 gardener-robot-ci-3 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Aug 8, 2023
@gardener-robot-ci-1 gardener-robot-ci-1 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Aug 8, 2023
ishan16696
ishan16696 approved these changes Aug 8, 2023
View reviewed changes
Copy link
Member

@ishan16696 ishan16696 left a comment

Choose a reason for hiding this comment

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

LGTM!!

shreyas-s-rao
shreyas-s-rao approved these changes Aug 11, 2023
View reviewed changes
Copy link
Collaborator

@shreyas-s-rao shreyas-s-rao left a comment

Choose a reason for hiding this comment

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

/lgtm

@shreyas-s-rao shreyas-s-rao merged commit 36b57c5 into master Aug 11, 2023
1 check passed
@shreyas-s-rao shreyas-s-rao deleted the personadocs branch August 11, 2023 06:48
@gardener-robot gardener-robot added the status/closed Issue is closed (either delivered or triaged) label Aug 11, 2023
@shreyas-s-rao shreyas-s-rao mentioned this pull request Aug 11, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shreyas-s-rao shreyas-s-rao shreyas-s-rao approved these changes

@ishan16696 ishan16696 ishan16696 approved these changes

@n-boshnakov n-boshnakov Awaiting requested review from n-boshnakov

Assignees
No one assigned
Labels
needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) reviewed/lgtm Has approval for merging size/s Size of pull request is small (see gardener-robot robot/bots/size.py) status/closed Issue is closed (either delivered or triaged)
Projects
None yet
Milestone
v0.26.0
Development

Successfully merging this pull request may close these issues.
9 participants
@vlerenc @n-boshnakov @gardener-robot @shreyas-s-rao @ishan16696 @gardener-robot-ci-1 @gardener-robot-ci-2 @gardener-robot-ci-3 @aaronfern