Skip to content

docs: remove misleading "Installing Serverless in an existing service" section#13449

Merged
czubocha merged 1 commit intomainfrom
sc-3922
Mar 31, 2026
Merged

docs: remove misleading "Installing Serverless in an existing service" section#13449
czubocha merged 1 commit intomainfrom
sc-3922

Conversation

@czubocha
Copy link
Copy Markdown
Contributor

@czubocha czubocha commented Mar 31, 2026 •
edited by coderabbitai bot
Loading

Summary

  • Removes the section that incorrectly suggested installing Serverless via package.json locks the framework version
  • In v4 the npm package is a thin wrapper that downloads and runs the framework — it doesn't provide a local pinned copy
  • Version pinning is done via frameworkVersion in serverless.yml, which is already documented in the "Version Pinning" section

Closes #13448

Test plan

  • Verify the "Version Pinning" section still exists and is accurate
  • Confirm no other docs reference the removed section

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Removed documentation section regarding Serverless installation and deployment procedures from the AWS services guide.

@czubocha @claude
docs: remove misleading "Installing Serverless in an existing service…
dcaa71d 
…" section

The section incorrectly suggested that installing Serverless via
package.json locks the framework version. In v4, the npm package is a
thin wrapper that downloads and runs the framework — it does not provide
a local pinned copy. Version pinning is done via frameworkVersion in
serverless.yml, already documented in the "Version Pinning" section.

Closes #13448

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Mmarzex
Copy link
Copy Markdown
Contributor

Mmarzex commented Mar 31, 2026 •
edited
Loading

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 31, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 72321781-7e62-4389-a862-3a1b2c8f6b76

📥 Commits

Reviewing files that changed from the base of the PR and between 9f6d4a0 and dcaa71d.

📒 Files selected for processing (1)
  • docs/sf/providers/aws/guide/services.md
💤 Files with no reviewable changes (1)
  • docs/sf/providers/aws/guide/services.md
📝 Walkthrough

Walkthrough

Documentation section removed from AWS provider guide that provided outdated instructions for installing Serverless as a dev dependency. The section incorrectly suggested this approach would lock the framework version, addressing confusion noted in related discussions.

Changes

Cohort / File(s) Summary
Documentation Cleanup
docs/sf/providers/aws/guide/services.md		 Removed the "Installing Serverless in an existing service" section (24 lines) that contained misleading guidance about locking framework versions via package.json installation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

Hop hop, a doc so clear and bright,
We pruned the words that weren't quite right,
No more confusion on what's true,
Our guide now guides, tried and through! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change—removing a misleading documentation section about installing Serverless.
Linked Issues check ✅ Passed The PR successfully addresses issue #13448 by removing the misleading section that incorrectly claimed package.json locks the framework version.
Out of Scope Changes check ✅ Passed All changes are directly aligned with the linked issue objective to remove misleading documentation about version pinning via package.json.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch sc-3922

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@czubocha czubocha merged commit 7e89a32 into main Mar 31, 2026
9 checks passed
@czubocha czubocha deleted the sc-3922 branch March 31, 2026 17:30
@github-actions github-actions bot locked and limited conversation to collaborators Mar 31, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs incorrectly state that the framework version can be locked using package.json

2 participants

@czubocha @Mmarzex