Skip to content

Awso migration#6884

Open
Apoorvkudesia-sumologic wants to merge 9 commits into
mainfrom
AWSOMigration
Open

Awso migration#6884
Apoorvkudesia-sumologic wants to merge 9 commits into
mainfrom
AWSOMigration

Conversation

@Apoorvkudesia-sumologic

@Apoorvkudesia-sumologic Apoorvkudesia-sumologic commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

This pull request adds changes for the AWSO 2.x.x to 3.x.x migration steps with manual and automation script docs.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Jul 10, 2026
@amee-sumo

Copy link
Copy Markdown
Collaborator

Review feedback

A few items to address before merge:

  1. Script download path unclear — In the CloudFormation migration doc (line 92), it says "Download the migration script from the sumologic-solution-templates repository" but doesn't provide a direct URL or curl command to download it. Users will need to search the repo. Consider adding a direct link, e.g.:

    curl -O https://raw.githubusercontent.com/SumoLogic/sumologic-solution-templates/main/<path>/MigrateToV300.sh
  2. Placeholder note in manual doc — Line 174 says "Images showing where to find the role ARN in the CloudFormation console and where to update it in Sumo Logic will be added here." This should be resolved before merge — either add the images or remove the note.

  3. Table rendering — In the scripted doc (line 145), --install-apps Yes\|No uses a backslash-pipe that may not render correctly. Consider using Yes/No or `Yes` or `No` instead.

  4. Horizontal rules — The manual doc uses --- separators between steps. These aren't commonly used elsewhere in this repo and add visual weight. Consider removing them for consistency.

— via Claude Code

@amee-sumo

Copy link
Copy Markdown
Collaborator

Review feedback (round 2)

A few more items from the latest revision:

  1. Missing download link for migration script (CloudFormation doc, line 92) — The doc says "Download the migration script from the sumologic-solution-templates repository" but still doesn't provide a direct URL or path. Users can't proceed without searching the repo. Please add a direct link or curl command, e.g.:

    curl -O https://raw.githubusercontent.com/SumoLogic/sumologic-solution-templates/main/<path>/MigrateToV300.sh
  2. Table rendering issue (CloudFormation doc, line 145) — --install-apps Yes\|No renders literally as Yes\|No. The backslash-escaped pipe doesn't work as expected in Markdown tables. Use Yes / No or `Yes` or `No` instead.

  3. Cross-reference link text mismatch (Manual doc, line 13) — The link says "using the migration script" but the linked page title is "Migrate AWS Observability from v2.x to v3.0.0 using CloudFormation". The link text should match the target page title for consistency.

— via Claude Code

@Apoorvkudesia-sumologic Apoorvkudesia-sumologic added the do-not-merge Pull requests that should not be merged label Jul 10, 2026
@amee-sumo

Copy link
Copy Markdown
Collaborator

Review feedback (round 3)

One remaining issue that will confuse users:

Duplicate numbered steps in manual doc (lines 154–166) — The "Find the new IAM role ARN" section has overlapping instructions. Steps 3–4 appear twice with slightly different wording, and the numbered list restarts at 3 after the first screenshot:

1. Go to AWS Console > CloudFormation > Stacks...
2. In the Resources tab, find CreateCommonResources...
3. In the CreateCommonResources stack, go to Resources...search for SumoLogicSourceRole.
4. Note the Physical ID...

[screenshot]

3. In the CreateCommonResources stack, go to Resources...search for SumoLogicSourceRole.  ← duplicate
4. Click the Physical ID link to open the IAM role.  ← duplicate

[screenshot]

5. On the IAM role page, copy the ARN...

This should be a single sequential list (1→2→3→4→5) with screenshots placed between the relevant steps. The old text from before the screenshots were added (lines 154–157) should be removed since lines 159–168 now cover the same steps with proper screenshots.

— via Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file do-not-merge Pull requests that should not be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants