Skip to content

Conversation

aimurphy
Copy link
Contributor

@aimurphy aimurphy commented Mar 31, 2025

Direct changes for Sideloader GA

Prepare for Sideloader GA (DOC-4238):

  • Bring Astra DB Sideloader docs from astra-vector-docs repo.
  • Separate the content into multiple pages. The first page is "About Sideloader" and you can see the other pages below that on the nav. Unless otherwise noted, the Astra DB sideloader content is the same, aside from the multi-page layout.
  • Add a small troubleshooting page, including the relaunch functionality (DOC-4510) and the current manual restart option.
  • Refresh the prerequisites and add some new ones. The PCU prerequisite and pricing information are under "Target Astra DB database requirements".
  • Refresh the ZDM Phase 2 page, and add sideloader as one of the options for Phase 2 of ZDM. I will probably edit this again in the future.
  • Add Astra DB Sideloader to the migration tools list on the migration docs index page. This is specifically for Astra DB and different from the DSE Sideloader. Note that this page will get more updates in a future PR.

General migration doc cleanup

Begin general cleanup of the migration docs:

  • Clean up redundant CDM content - The same partials were used on cdm-overview.adoc + cdm-steps.adoc and cassandra-data-migrator.adoc. There was no difference between the instructions aside from being on two pages vs one page. Now, the content is all on cassandra-data-migrator.adoc, and cdm-overview.adoc just includes the entire body of cassandra-data-migrator.adoc.
  • Remove CDM parameters content that was supposed to be removed in DOC-4573
  • Remove redundant partials (small amounts of content, content that was used only once, content that was commented out)
  • Remove unnecessary usage of ifdef and {imageprefix}
  • Replace outdated release notes page with links to GitHub repos for ZDM proxy, ZDM automation, and CDM.
  • Add links to migration content in other docsets (until we can do a more formal alignment).

The following pages will receive further edits in future PRs. They don't need a detailed review at this time:

⚠️ Dependent PRs

This PR is dependent on:

@aimurphy aimurphy self-assigned this Mar 31, 2025
@plpesvc-ds

This comment was marked as resolved.

@plpesvc-ds
Copy link

plpesvc-ds commented Mar 31, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Mar 31, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Mar 31, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 1, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 1, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 1, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 3, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

Copy link
Collaborator

@alicel alicel left a comment

Choose a reason for hiding this comment

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

submitting my comments so far

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 7, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 7, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

Copy link
Contributor

@eric-schneider eric-schneider left a comment

Choose a reason for hiding this comment

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

Reviewed the general migration doc cleanup. Will follow up with Sideloader + approval later tonight or tomorrow morning.

Copy link
Contributor

@eric-schneider eric-schneider left a comment

Choose a reason for hiding this comment

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

As always, I left a mix of observations, optional suggestions, and error corrections. This was a really long review so I'm bound to have left some pretty eye-roll comments, so please don't feel obligated to respond to any them unless you feel like it (and have time). I trust you to make the appropriate decisions with my feedback (otherwise I wouldn't have approved). Just know that I do take the time to read responses to resolved comments 🙂.

I'll end by saying that you did some phenomenal work here. This wasn't an easy feature to document, let alone migrate to a different docset. Great job! 👏👏👏

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 14, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 14, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 15, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 15, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 15, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 22, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds

This comment was marked as duplicate.

@plpesvc-ds

This comment was marked as duplicate.

@plpesvc-ds
Copy link

Build failure! ❌

[22:30:38.754] ERROR (asciidoctor): target of include not found: common:streaming:partial$cdc/cdc-for-astra-db.adoc file: modules/databases/pages/change-data-capture.adoc:5 source: https://github.com/riptano/astra-vector-docs.git (branch: doc-4238) > tailwindcss > tailwindcss build -c ${npm_config_tailwind_config_path} -i ${npm_config_css_path} -o ${npm_config_css_path} --minify Browserslist: caniuse-lite is outdated. Please run: npx update-browserslist-db@latest Why you should do it regularly: https://github.com/browserslist/update-db#readme Rebuilding... Done in 9062ms.

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 23, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 23, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

@jeromatron
Copy link
Collaborator

For Azure in the migration section (https://d5rxiv0do0q3v.cloudfront.net/doc-4238/data-migration/sideloader/migrate-sideloader.html), it says that Azure is in private preview. Can we get rid of that preview language for GA? I believe everything will be GA (except flexible PCU which has its own section and notes) and we don't need sideloader cloud specific preview notes any longer. Does that make sense?

@plpesvc-ds
Copy link

plpesvc-ds commented Apr 29, 2025

Build successful! ✅
Pull requests with matching branch name doc-4238 included in the build:

Deploying draft.
Deploy successful! View draft

Copy link
Collaborator

@jeromatron jeromatron left a comment

Choose a reason for hiding this comment

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

Looks great, thank you April!

@aimurphy aimurphy merged commit f51b4fd into main Apr 30, 2025
1 check passed
@aimurphy aimurphy deleted the doc-4238 branch April 30, 2025 21:02
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.

6 participants