Merge docs-uplift feature branch into master #246
Conversation
* Initial ToC work and installation reorg * Updates database connections section * Revise Projects section * Updates Data Modeling section * Update Data Migration section * Moves Kafka Deployment guide into prod installation guide * Renames User Interface page * Mark Containerized cluster as orphan page
DOCSP-47550 Update the docker documentation
* DOCSP-47555 updates db connection pages * Refactor mysql page * Adds all UI locations for adding a connection * Revisions based on feedback * Moves some content to includes for reuse * Try to replace a guilabel * Try splitting procedure into reusable components * Trying again * Revise * Fix chart rendering * Move step 4 outside the include to fix rendering * Update file location link for future IA * Finalize format * Revise intro * Complete sentences * Add scaffolding for all pages and init commit for oracle * Add additional substitution to fix indef article in includes * Adds postgres * Adds sql server * Fix sql server db preparation steps * Adds db2 * Adds sybase * Adds MongoDB * Nest db configuration docs under connection pages * Add about this task section * Updates scenario and removes ambiguous ref targets * Revert change to mysql setup permissions include * Fixes bad refs * Updates per modfac new joiner feedback * Responds to internal review * Fix c2c broken link
* DOCSP-47552 initial commit * Update deb install to incl changes in mongodb#216 * Update local installation version number formats * Update debian server page * Adds rhel server steps * Update next steps to projects page * Adds windows procedure * Responds to internal feedback * Update rhel bin sentence * Expands RHEL to Red Hat Enterprise Linux
* DOCSP-47554 update database connections landing page * Revise page * Fix typo * Adds link to new additional options page * Remove extra backtick * Responds to internal review feedback * Complete sentences * Updates section heading and fixes punctuation * Responds to ext feedback * Updates toc label per best practices * Rephrases migrator without db connection to emphasize visualize & model data * Updates text for listed non-db options
* DOCSP-47547 update the getting started page * Small edit * Update introductory text and ref labels * Remove ambiguous ref labels * Refactor migration scenarios * Adds link to User Interface overview * Responds to internal feedback * Add missing space * Fix continous migration section * Updates compatiblity tables * Updates feature order and wording per pmm feedback * Adds jdbc dbs to supported migration types * Remove link * Updates destination to target
DOCSP-48084: Add product name to snooty.toml
* DOCSP-47559 updates the data modeling page * Re-order content for better flow * Adds mention of refreshing rdb model * Removes custom mapping heading * Responds to internal feedback * Moves mapping rules definition to page intro * Responds to external feedback * Fix link * Fix link again
…db#232) * DOCSP-47556 adds a page for using RM without a live connection * Add new page to toc_landing_pages * Revise wording * Update DDL file ToC label * Revise DDL page title * removes comma
…ongodb#243) * DOCSP-47546 and DOCSP-47567 delete unused files and create redirects * Adds missed files from initial redirects * Update references to pages that no longer exist * Remove a missed file * Fix bad link ref
…derations (mongodb#217) * DOCSP-47548 Updates the installation page to include deployment considerations * Updates recommendation table * Update get started section to point to top level dev and prod install guides * Combines description table and recommendations table * Revise wording to be parallel and remove lists in tables * Parallelism * Revise intro para to match new table * Remove intro para * revise unattended server scenario * Responds to internal feedback * Update link text * Revises deployment model table to include ext review feedback * Test 4 column deployment model table * Adds widths * Fix confluent row * Makes updates requested in review session * Fixes vale errors * Responds to RM eng team feedback * Fixes vale error * Small wording update * Makes requested updates from internal re-review
…mongodb#245) * DOCSP-48624-uplift * Revise tips * Update source/mapping-rules/schema-mapping.txt Co-authored-by: ltran-mdb2 <143426234+ltran-mdb2@users.noreply.github.com> * Update source/database-connections/oracle.txt Co-authored-by: ltran-mdb2 <143426234+ltran-mdb2@users.noreply.github.com> --------- Co-authored-by: ltran-mdb2 <143426234+ltran-mdb2@users.noreply.github.com>
✅ Deploy Preview for docs-relational-migrator ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
I notice that when I click on the Connect to Databases LHS menu, there is no longer a page load just the menu expansion. has this page been intentionally hidden/moved? I can't find it so wanted to confim this is intentional |
Good catch @davidsoulmdb, thanks! This was unintentional. I pushed a fix and the Connect to Databases page should now appear when you click on the menu. |
There was a problem hiding this comment.
Thanks so much for your patience @jwilson-mdb! I've done a pretty lite copy edit on the main parts you mentioned. I've added a bunch of non-blocking suggestions. Everything looks really really good.
I think it might make sense to add a copy edit to our list of content updates. There are a few stylistic differences in the pages that might be worth smoothing out. WDYT? Really happy to talk this over later today or tomorrow, also.
source/getting-started.txt
Outdated
| Use Cases | ||
| --------- | ||
|
|
||
| {+rel-mig+} supports both Snapshot and Continuous migration jobs. |
There was a problem hiding this comment.
(question)
Where would I read more about each scenario?
There was a problem hiding this comment.
Updated migration jobs plaintext to be a link that points to the Types of Migration Jobs section
There was a problem hiding this comment.
Optional suggestion: mention that snapshot jobs can also be used for batched jobs on getting-started
Snapshot: Snapshot migration jobs run once, typically for a point in time migration strategy. ->
Snapshot: Snapshot migration jobs run once and shut down. Suitable for migrating a full database at a point in time, batch migrations, and incremental data syncs eg nightly runs. Larger database migrations may be split into batches using id or date-based table filters and run in parallel for improved performance.
There was a problem hiding this comment.
I tweaked the wording a bit, but updated the snapshot description to read:
Snapshot migration jobs migrate all data once, and then stop. You can
use snapshot migrations for point-in-time database migrations,
batch migrations, and incremental syncs. You can also use them with
:ref:`table filters <rm-table-filters>` to split large migration jobs
into parallel batches to improve performance.
| connection speed. | ||
|
|
||
| After the migration completes, take your legacy application offline and | ||
| launch your new application. |
There was a problem hiding this comment.
(question)
Is there a link you can provide for more information?
There was a problem hiding this comment.
As far as I know, we don't have any content covering this. The upcoming "Migration Planning Guide" doc would be the likely target. I'll make a note in my planning doc to crosslink these scenario sections with corresponding guide sections.
jwilson-mdb
force-pushed
the
docs-uplift
branch
from
ad04171 to
04a0481
Compare
|
Overall could publish as-is, I do haave some minor wording tweaks to suggest but could also hold off until v2? installation - LGTM getting-started/ optional suggstions?
For discussion on database-connections/:
Connect to MySQL -> MySQL Database Guide
To connect to the destination database, see Connect to MongoDB. Without live db page:
|
The linked section has all supported JDBC dbs listed in the table.
Updated!
If you are referring to the titles on those procedural pages, our docs style guide specifies that task page titles should begin with a present tense action verb.
I think this change makes more sense to include with the JDBC connection strings DOCSP ticket. Adding it to the
Updated to use your suggestion
Tweaked the wording a bit, but updated to explain what northwind is |
DESCRIPTION
Merges
docs-upliftintomasterSTAGING
https://deploy-preview-246--docs-relational-migrator.netlify.app/
Notable/Large changes:
JIRA
https://jira.mongodb.org/browse/DOCSP-48961
Self-Review Checklist
External Review Requirements
What's expected of an external reviewer?