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

DOCSP-48670-update-oracle-prereqs #247

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

mmaville-mdb
Copy link
Collaborator

@mmaville-mdb mmaville-mdb commented Apr 8, 2025

DESCRIPTION

Addressing backlog of updates for the migration requisites page for Oracle. A new tab contains the RDS specific instructions, with edits for all relevant feedback interlaced throughout the ticket. Both Snapshot Jobs and Continuous Jobs had minor edits per feedback.

STAGING

Configure Migration Prerequisites for Oracle - Steps:

  • Snapshot Jobs
  • Continuous Jobs
  • Continuous Jobs (Amazon RDS)

JIRA

https://jira.mongodb.org/browse/DOCSP-48670

BUILD LOG

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Is this free of spelling errors?
  • Is this free of grammatical errors?
  • Is this free of staging / rendering issues?
  • Are all the links working?

External Review Requirements

What's expected of an external reviewer?

Copy link

netlify bot commented Apr 8, 2025

Deploy Preview for docs-relational-migrator ready!

Name Link
🔨 Latest commit 188a642
🔍 Latest deploy log https://app.netlify.com/sites/docs-relational-migrator/deploys/67f7fdc9860c820008370c87
😎 Deploy Preview https://deploy-preview-247--docs-relational-migrator.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 27 (🔴 down 14 from production)
Accessibility: 85 (🔴 down 13 from production)
Best Practices: 75 (no change from production)
SEO: 75 (🔴 down 8 from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@jason-price-mongodb jason-price-mongodb left a comment

Choose a reason for hiding this comment

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

@mmaville-mdb lgtm with suggestions. Cheers.


.. step:: Turn on archive logging

a. To see if archive logging is already enabled, run the following query:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Consider "To examine if ..."

@@ -33,7 +33,14 @@ About this Task
architecture, see `Overview of Container Databases and Pluggable Databases <https://oracle-base.com/articles/12c/multitenant-overview-container-database-cdb-12cr1>`__.
- Some commands differ based on whether the database is single or
multi-tenant. In a multi-tenant database, permissions must
include the suffix ``CONTAINER=ALL``.
include the suffix ``CONTAINER=ALL``. To check whether the database is
Copy link
Collaborator

Choose a reason for hiding this comment

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

Consider "To examine whether..."

Copy link

@shybovycha shybovycha left a comment

Choose a reason for hiding this comment

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

have a few suggestions, but overall LGTM

@@ -33,7 +33,14 @@ About this Task
architecture, see `Overview of Container Databases and Pluggable Databases <https://oracle-base.com/articles/12c/multitenant-overview-container-database-cdb-12cr1>`__.
- Some commands differ based on whether the database is single or
multi-tenant. In a multi-tenant database, permissions must
include the suffix ``CONTAINER=ALL``.
include the suffix ``CONTAINER=ALL``. To examine whether the database is
multi-tenant or not, run the following SQL query:

Choose a reason for hiding this comment

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

personal take on the previous feedback (but take it with a pinch of salt): I would not phrase it like this

To examine whether the database is multi-tenant or not

for a simple check / confirmation. this is not an exploration or a detailed investigation but rather a very simple check "true / false"

i think "to check" would be a better fit here


.. step:: Turn on archive logging

a. To see if archive logging is already enabled, run the following query:
a. To examine if archive logging is already enabled, run the following query:

Choose a reason for hiding this comment

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

same as with multi-tenancy check, in my personal opinion, "to examine" is a very strong / fancy word here for a mere "true / false" check


.. step:: Set up user permissions

This procedure applies to Oracle instances which **are

Choose a reason for hiding this comment

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

np: i am not really sure why there is an emphasis on **are hosted** ? if we were to add an emphasis, it would make sense to put it on **Amazon RDS**, but given this entire section is already behind a tab, i think any more emphasis here is unnecessary

.. procedure::
:style: normal

.. step:: Set up user permissions

Choose a reason for hiding this comment

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

np: it might make more sense to put the next sentence before the ordered step list, potentially in a "important" banner:

This procedure applies to Oracle instances which are hosted on Amazon RDS

  1. Set up user permissions
    ...


.. step:: Turn on archive logging

a. To examine if archive logging is already enabled, run the following query:

Choose a reason for hiding this comment

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

np: i think to examine is a strong word for a mere "true / false" check; my personal preference would be to use to check instead

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.

3 participants