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

Replace outdated bucket placeholders with updated example buckets. #8919

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

DavidSouther
Copy link

Issue #, if available:

There is an internal effort to rename placeholder BUCKET_NAMES with reserved bucket_names across AWS docs.

Description of changes:

Performed an update across example files using sed -I '' -f .../buckets.sed **/*.rst from the examples folder.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@DavidSouther DavidSouther marked this pull request as draft September 13, 2024 20:16
@DavidSouther
Copy link
Author

Script was

s/DOC-EXAMPLE-BUCKET/amzn-s3-demo-bucket/g
s/DOC-EXAMPLE-BUCKET1/amzn-s3-demo-bucket1/g
s/DOC-EXAMPLE-BUCKET2/amzn-s3-demo-bucket2/g
s/DOC-EXAMPLE-BUCKET3/amzn-s3-demo-bucket3/g
s/DOC-EXAMPLE-SOURCE-BUCKET/amzn-s3-demo-source-bucket/g
s/DOC-EXAMPLE-DESTINATION-BUCKET/amzn-s3-demo-destination-bucket/g
s/DOC-EXAMPLE-SOURCE-BUCKET1/amzn-s3-demo-source-bucket1/g
s/DOC-EXAMPLE-DESTINATION-BUCKET1/amzn-s3-demo-destination-bucket1/g
s/DOC-EXAMPLE-SOURCE-BUCKET2/amzn-s3-demo-source-bucket2/g
s/DOC-EXAMPLE-DESTINATION-BUCKET2/amzn-s3-demo-destination-bucket2/g
s/DOC-EXAMPLE-LOGGING-BUCKET/amzn-s3-demo-logging-bucket/g
s/DOC-EXAMPLE-LOGGING-BUCKET1/amzn-s3-demo-logging-bucket1/g
s/DOC-EXAMPLE-LOGGING-BUCKET2/amzn-s3-demo-logging-bucket2/g
s/DOC-EXAMPLE-WEBSITE-BUCKET/amzn-s3-demo-website-bucket/g
s/DOC-EXAMPLE-WEBSITE-BUCKET1/amzn-s3-demo-website-bucket1/g
s/DOC-EXAMPLE-WEBSITE-BUCKET2/amzn-s3-demo-website-bucket2/g
s/DOC-EXAMPLE-BUCKET--usw2-az1--x-s3/amzn-s3-demo-bucket--usw2-az1--x-s3/g
s/DOC-EXAMPLE-BUCKET1--usw2-az1--x-s3/amzn-s3-demo-bucket1--usw2-az1--x-s3/g
s/DOC-EXAMPLE-BUCKET2--usw2-az1--x-s3/amzn-s3-demo-bucket2--usw2-az1--x-s3/g
s/DOC-EXAMPLE-BUCKET3--usw2-az1--x-s3/amzn-s3-demo-bucket3--usw2-az1--x-s3/g
s/DOC-EXAMPLE-SOURCE-BUCKET--usw2-az1--x-s3/amzn-s3-demo-source-bucket--usw2-az1--x-s3/g
s/DOC-EXAMPLE-DESTINATION-BUCKET--usw2-az1--x-s3/amzn-s3-demo-destination-bucket--usw2-az1--x-s3/g
s/DOC-EXAMPLE-SOURCE-BUCKET1--usw2-az1--x-s3/amzn-s3-demo-source-bucket1--usw2-az1--x-s3/g
s/DOC-EXAMPLE-DESTINATION-BUCKET1--usw2-az1--x-s3/amzn-s3-demo-destination-bucket1--usw2-az1--x-s3/g
s/DOC-EXAMPLE-SOURCE-BUCKET2--usw2-az1--x-s3/amzn-s3-demo-source-bucket2--usw2-az1--x-s3/g
s/DOC-EXAMPLE-DESTINATION-BUCKET2--usw2-az1--x-s3/amzn-s3-demo-destination-bucket2--usw2-az1--x-s3/g

@DavidSouther DavidSouther marked this pull request as ready for review September 18, 2024 19:20
@codecov-commenter
Copy link

codecov-commenter commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.08%. Comparing base (f70e1e3) to head (7e798a8).
Report is 25 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff             @@
##           develop   #8919      +/-   ##
==========================================
- Coverage     0.08%   0.08%   -0.01%     
==========================================
  Files          210     210              
  Lines        16902   16911       +9     
==========================================
  Hits            14      14              
- Misses       16888   16897       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@elysahall elysahall added the documentation This is a problem with documentation. label Sep 23, 2024
@elysahall
Copy link
Collaborator

Commenting for posterity. Spoke to David offline about fixing some of the regex replacements.

@DavidSouther
Copy link
Author

DavidSouther commented Sep 23, 2024

Looks like a couple stragglers found with git grep -l '[^\/:]amzn.*bucket':

s/awsamzn-s3-demo-bucket/amzn-s3-demo-bucket/gi
s/MY-S3-amzn-s3-demo-bucket/amzn-s3-demo-bucket/gi

Update search to be case insensitive

Remove aws... and my-s3-... prefixes

Remove dashes in -1 -2
Copy link
Collaborator

@elysahall elysahall left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants