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.

Sign up for GitHub

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

Jump to bottom

ref(aws-lambda): Restructure and improve AWS Lambda SDK documentation #10655

Merged
merged 3 commits into from
Jul 23, 2024
Merged

ref(aws-lambda): Restructure and improve AWS Lambda SDK documentation #10655

merged 3 commits into from
Jul 23, 2024

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Jul 11, 2024 •
edited
Loading

DESCRIBE YOUR PR

This PR extensively restructures and improves the Javascript Node AWS Lambda SDK documentation:

  • Added specfic setup guides (including <OnboardingOption> component)
    • CommonJS functions + Lambda Layer (recommended)
    • CommonJS functions + NPM package
    • ESM functions + NPM package (layer not yet available for ESM; we're working on that)
    • Some of these pages include alternative ways within the guides but we always show the simplest way on top.
  • Modified top-level "Getting Started" page to no longer show a convolution of NPM instructions and config options. Instead, we link to the recommended setup guides for CJS and ESM and:
  • Extracted Lambda wrapper options to their own page under "Configuration"
  • Removed completely outdated Cloud Image guide
    • we don't publish cloud images since ~3 years
    • added a redirect to "Installation Methods"
  • Removed top-level Lambda layer guide in favour of new CJS+Layer guide in "Installation Methods"

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

ref getsentry/sentry-javascript#12409

@vercel Vercel
Copy link

vercel bot commented Jul 11, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 22, 2024 9:10am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 22, 2024 9:10am

@Lms24 Lms24 requested review from lforst and andreiborza July 11, 2024 15:35
@Lms24 Lms24 self-assigned this Jul 11, 2024
@Lms24 Lms24 mentioned this pull request Jul 11, 2024
Closed
@codecov Codecov
Copy link

codecov bot commented Jul 11, 2024 •
edited
Loading

Bundle Report

Changes will increase total bundle size by 1.77kB ⬆️

Bundle name Size Change
sentry-docs-server 9.53MB 1.54kB ⬆️
sentry-docs-edge-server 255.46kB 227 bytes ⬆️
sentry-docs-client 8.18MB 6 bytes ⬇️

@Lms24
Copy link
Member Author

Lms24 commented Jul 23, 2024

I'm gonna merge this since a couple of users were asking about AWS lambda setup recently and our current docs are broken. If anyone has improvement suggestions, please tag me, I'm happy to address them in a follow-up PR.

@Lms24 Lms24 merged commit f13e2f6 into master Jul 23, 2024
10 checks passed
@Lms24 Lms24 deleted the lms/ref-aws-lambda-docs branch July 23, 2024 08:06
lforst pushed a commit that referenced this pull request Jul 24, 2024
@Lms24 @andreiborza @lforst
ref(aws-lambda): Restructure and improve AWS Lambda SDK documentation (…
0be7d0f 
…#10655)


---------

Co-authored-by: Andrei <[email protected]>
@github-actions github-actions bot locked and limited conversation to collaborators Aug 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@andreiborza andreiborza andreiborza approved these changes

@lforst lforst Awaiting requested review from lforst

Assignees

@Lms24 Lms24

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Lms24 @andreiborza