-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
OADP-3182: Split and Tidy up Release Notes #68923
Conversation
@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:
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: 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:
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: 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:
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. |
🤖 Updated build preview is available at: Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/36427 |
@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:
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: 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:
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. |
/label OADP |
LGTM |
/label peer-review-needed |
/remove-label peer-review-needed |
/remove-label peer-review-in-progress Don't forget to squash your commits. |
7d28886
to
7a78121
Compare
@tmalove - thanks very much |
/label merge-review-needed |
@adellape - opinion required - do you think this is an improvement and makes more sense? |
There was a problem hiding this 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]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't have xref
s 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]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't have xref
s in modules.
_topic_maps/_topic_map.yml
Outdated
Dir: release-notes | ||
Topics: | ||
- Name: OADP 1.3 release notes | ||
File: oadp-release-notes |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
11c6536
to
a80f82a
Compare
/label merge-review-needed |
|
||
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] |
There was a problem hiding this comment.
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/ |
There was a problem hiding this comment.
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 ../../
.
There was a problem hiding this comment.
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
Signed-off-by: Andy Arnold <anarnold@redhat.com>
055129c
to
099a81d
Compare
/label merge-review-needed |
* 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]. |
There was a problem hiding this comment.
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.
/cherrypick enterprise-4.15 |
/cherrypick enterprise-4.14 |
/cherrypick enterprise-4.13 |
/cherrypick enterprise-4.12 |
@adellape: new pull request created: #69057 In response to this:
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: new pull request created: #69058 In response to this:
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: new pull request created: #69059 In response to this:
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: new pull request created: #69060 In response to this:
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. |
Jira
Version:
Doc preview
QE review: