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

OADP-3182: Split and Tidy up Release Notes #68923

Merged

Conversation

anarnold97
Copy link
Contributor

@anarnold97 anarnold97 commented Dec 5, 2023

Jira

Version:

  • OCP 4.12 → branch/enterprise-4.12
  • OCP 4.13 → branch/enterprise-4.13
  • OCP 4.14 → branch/enterprise-4.14
  • OCP 4.15 → branch/enterprise-4.15

Doc preview

QE review:

  • QE has approved this change.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Dec 5, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 5, 2023

@anarnold97: This pull request references OADP-3182 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.15.0" version, but no target version was set.

In response to this:

Jira

Version:

  • OCP 4.12 → branch/enterprise-4.12
  • OCP 4.13 → branch/enterprise-4.13
  • OCP 4.14 → branch/enterprise-4.14
  • OCP 4.15 → branch/enterprise-4.15

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci-robot
Copy link

@anarnold97: This pull request references OADP-3182 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.15.0" version, but no target version was set.

In response to this:

Jira

Version:

  • OCP 4.12 → branch/enterprise-4.12
  • OCP 4.13 → branch/enterprise-4.13
  • OCP 4.14 → branch/enterprise-4.14
  • OCP 4.15 → branch/enterprise-4.15

Doc preview

  • [OADP 1.3 release notes]
  • [OADP 1.2 release notes]
  • [OADP 1.1 release notes]

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 5, 2023

@anarnold97: This pull request references OADP-3182 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.15.0" version, but no target version was set.

In response to this:

Jira

Version:

  • OCP 4.12 → branch/enterprise-4.12
  • OCP 4.13 → branch/enterprise-4.13
  • OCP 4.14 → branch/enterprise-4.14
  • OCP 4.15 → branch/enterprise-4.15

Doc preview

  • [OADP 1.3 release notes]
  • [OADP 1.2 release notes]
  • [OADP 1.1 release notes]

QE review:

  • QE has approved this change.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Dec 5, 2023

🤖 Updated build preview is available at:
https://68923--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/36427

@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 5, 2023

@anarnold97: This pull request references OADP-3182 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.15.0" version, but no target version was set.

In response to this:

Jira

Version:

  • OCP 4.12 → branch/enterprise-4.12
  • OCP 4.13 → branch/enterprise-4.13
  • OCP 4.14 → branch/enterprise-4.14
  • OCP 4.15 → branch/enterprise-4.15

Doc preview

QE review:

  • QE has approved this change.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 5, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 5, 2023

@anarnold97: This pull request references OADP-3182 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.15.0" version, but no target version was set.

In response to this:

Jira

Version:

  • OCP 4.12 → branch/enterprise-4.12
  • OCP 4.13 → branch/enterprise-4.13
  • OCP 4.14 → branch/enterprise-4.14
  • OCP 4.15 → branch/enterprise-4.15

Doc preview

QE review:

  • QE has approved this change.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@anarnold97
Copy link
Contributor Author

/label OADP

@openshift-ci openshift-ci bot added the OADP Label for all OADP PRs label Dec 5, 2023
@PrasadJoshi12
Copy link

LGTM

@anarnold97
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Dec 6, 2023
@tmalove
Copy link
Contributor

tmalove commented Dec 6, 2023

/remove-label peer-review-needed
/label peer-review-in-progress

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Dec 6, 2023
@tmalove
Copy link
Contributor

tmalove commented Dec 6, 2023

/remove-label peer-review-in-progress
/label peer-review-done

Don't forget to squash your commits.

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Dec 6, 2023
@anarnold97 anarnold97 force-pushed the OADP-3182-Split-and-Tidy-Release-Notes branch from 7d28886 to 7a78121 Compare December 6, 2023 15:08
@anarnold97
Copy link
Contributor Author

@tmalove - thanks very much

@anarnold97
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Dec 6, 2023
@adellape adellape added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Dec 6, 2023
@adellape adellape self-assigned this Dec 6, 2023
@anarnold97
Copy link
Contributor Author

@adellape - opinion required - do you think this is an improvement and makes more sense?

Copy link
Contributor

@adellape adellape left a comment

Choose a reason for hiding this comment

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

A few things to address before merge.

@adellape - opinion required - do you think this is an improvement and makes more sense?

I think it is a worthwhile change, yes! Makes reading the latest version much cleaner for sure.

@@ -15,14 +15,14 @@ The OADP 1.2.0 release notes include information about new features, bug fixes,
The new `resourceTimeout` option specifies the timeout duration in minutes for waiting on various Velero resources. This option applies to resources such as Velero CRD availability, `volumeSnapshot` deletion, and backup repository availability. The default duration is 10 minutes.

.AWS S3 compatible backup storage providers
You can back up objects and snapshots on AWS S3 compatible providers. For more details, see xref:../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#migration-configuring-aws-s3_installing-oadp-aws[Configuring Amazon Web Services].
You can back up objects and snapshots on AWS S3 compatible providers. For more details, see xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#migration-configuring-aws-s3_installing-oadp-aws[Configuring Amazon Web Services].
Copy link
Contributor

Choose a reason for hiding this comment

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

Can't have xrefs in modules. Will need to move the link to an "Additional resources" list at the assembly-level.



[id="new-features-tech-preview-1-2-0_{context}"]
=== Technical preview features

.Data Mover
The OADP Data Mover enables you to back up Container Storage Interface (CSI) volume snapshots to a remote object store. When you enable Data Mover, you can restore stateful applications using CSI volume snapshots pulled from the object store in case of accidental cluster deletion, cluster failure, or data corruption. For more information, see xref:../../backup_and_restore/application_backup_and_restore/installing/oadp-using-data-mover-for-csi-snapshots-doc.adoc#oadp-using-data-mover-for-csi-snapshots-doc[Using Data Mover for CSI snapshots].
The OADP Data Mover enables you to back up Container Storage Interface (CSI) volume snapshots to a remote object store. When you enable Data Mover, you can restore stateful applications using CSI volume snapshots pulled from the object store in case of accidental cluster deletion, cluster failure, or data corruption. For more information, see xref:../../../backup_and_restore/application_backup_and_restore/installing/oadp-using-data-mover-for-csi-snapshots-doc.adoc#oadp-using-data-mover-for-csi-snapshots-doc[Using Data Mover for CSI snapshots].
Copy link
Contributor

Choose a reason for hiding this comment

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

Can't have xrefs in modules.

Dir: release-notes
Topics:
- Name: OADP 1.3 release notes
File: oadp-release-notes
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason not to make this oadp-release-notes-1-3 like the others at this point (vs re-using the old file name)? Or is the idea that you want the oadp-release-notes.adoc file to always be representative of the latest Y-version?

@@ -0,0 +1 @@
../../images
Copy link
Contributor

Choose a reason for hiding this comment

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

The _attributes and snippets symlinks are correct, using ../../../ levels. However, this images one and the modules one below are currently using ../../, which technically works because it's hitting the symlink in the backup_and_restore directory, but really they should also be ../../../.

@@ -0,0 +1 @@
../../modules
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here as the images symlink comment.

@anarnold97
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Dec 6, 2023
@adellape adellape added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Dec 6, 2023

The release notes for OpenShift API for Data Protection (OADP) describe new features and enhancements, deprecated features, product recommendations, known issues, and resolved issues.

include::modules/oadp-release-notes-1-3-0.adoc[leveloffset=+1]
Copy link
Contributor

Choose a reason for hiding this comment

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

Reminder to update the "Module included in the following assemblies:" list in the metadata of modules/oadp-release-notes-1-3-0.adoc now that the assembly file name has changed to oadp-release-notes-1-3.adoc.

@@ -0,0 +1 @@
../../modules/
Copy link
Contributor

Choose a reason for hiding this comment

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

The images symlink was fixed to ../../../, but this modules one is still only ../../.

Copy link
Contributor Author

@anarnold97 anarnold97 Dec 6, 2023

Choose a reason for hiding this comment

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

Hahaha... ok I will fix this one... but i am not fixing every other one that is wrong. Just thought I would copy one of the modules three levels down but they are all wrong. Dammit

@adellape adellape removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Dec 6, 2023
Signed-off-by: Andy Arnold <anarnold@redhat.com>
@anarnold97 anarnold97 force-pushed the OADP-3182-Split-and-Tidy-Release-Notes branch from 055129c to 099a81d Compare December 6, 2023 22:12
@anarnold97
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Dec 6, 2023
Comment on lines +24 to +25
* xref:../../../backup_and_restore/application_backup_and_restore/installing/installing-oadp-aws.adoc#migration-configuring-aws-s3_installing-oadp-aws[Configuring Amazon Web Services].
* xref:../../../backup_and_restore/application_backup_and_restore/installing/oadp-using-data-mover-for-csi-snapshots-doc.adoc#oadp-using-data-mover-for-csi-snapshots-doc[Using Data Mover for CSI snapshots].
Copy link
Contributor

Choose a reason for hiding this comment

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

Not blocking merge for this, but just noticed periods on the ends of these bullets that could be removed in a later PR.

@adellape adellape merged commit 4fb3beb into openshift:main Dec 7, 2023
1 check passed
@adellape
Copy link
Contributor

adellape commented Dec 7, 2023

/cherrypick enterprise-4.15

@adellape
Copy link
Contributor

adellape commented Dec 7, 2023

/cherrypick enterprise-4.14

@adellape
Copy link
Contributor

adellape commented Dec 7, 2023

/cherrypick enterprise-4.13

@adellape
Copy link
Contributor

adellape commented Dec 7, 2023

/cherrypick enterprise-4.12

@openshift-cherrypick-robot

@adellape: new pull request created: #69057

In response to this:

/cherrypick enterprise-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@adellape: new pull request created: #69058

In response to this:

/cherrypick enterprise-4.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@adellape: new pull request created: #69059

In response to this:

/cherrypick enterprise-4.13

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@adellape: new pull request created: #69060

In response to this:

/cherrypick enterprise-4.12

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@adellape adellape removed the merge-review-needed Signifies that the merge review team needs to review this PR label Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.12 branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. OADP Label for all OADP PRs peer-review-done Signifies that the peer review team has reviewed this PR 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.

None yet

7 participants