-
Notifications
You must be signed in to change notification settings - Fork 376
Fix: Update Node.js content to Express.js for all affected versions (Product IS issue #26411) #5775
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
base: master
Are you sure you want to change the base?
Fix: Update Node.js content to Express.js for all affected versions (Product IS issue #26411) #5775
Conversation
…product-is#26411) This change updates all documentation references from "Node.js" to "Express.js" in titles and content where applicable. The guides use Express.js as the framework (not vanilla Node.js), so Express.js is more accurate. Changes include: - Updated quickstart titles and metadata to reference Express.js - Updated complete guide headings and content to use Express.js terminology - Updated navigation menu items in mkdocs.yml files - Maintained Node.js references where referring to the runtime/installation Affected versions: - Identity Server 7.1.0 - Identity Server 7.2.0 - Identity Server next 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
WalkthroughDocumentation updates rename Node.js references to Express.js across multiple versions (7.1.0, 7.2.0, next) and shared includes. Changes include headings, navigation paths, sample references, and introductory text, consistently updating framework terminology from Node.js to Express.js. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~12 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (2)
en/identity-server/7.1.0/docs/quick-starts/nodejs.md (1)
30-30: Nice-to-have: Fix pre-existing typos in the tip section.The tip section contains pre-existing typos unrelated to this PR that could be addressed in a follow-up: "Excute" (Execute) and "Naviate" (Navigate).
Also applies to: 32-32
en/identity-server/7.2.0/docs/quick-starts/nodejs.md (1)
30-30: Nice-to-have: Fix pre-existing typos in the tip section.The tip section contains pre-existing typos unrelated to this PR that could be addressed in a follow-up: "Excute" (Execute) and "Naviate" (Navigate).
Also applies to: 32-32
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (19)
en/identity-server/7.1.0/docs/complete-guides/nodejs/accessing-protected-api.md(1 hunks)en/identity-server/7.1.0/docs/complete-guides/nodejs/create-a-nodejs-app.md(1 hunks)en/identity-server/7.1.0/docs/complete-guides/nodejs/introduction.md(1 hunks)en/identity-server/7.1.0/docs/quick-starts/nodejs.md(2 hunks)en/identity-server/7.1.0/mkdocs.yml(3 hunks)en/identity-server/7.2.0/docs/complete-guides/nodejs/accessing-protected-api.md(1 hunks)en/identity-server/7.2.0/docs/complete-guides/nodejs/create-a-nodejs-app.md(1 hunks)en/identity-server/7.2.0/docs/complete-guides/nodejs/introduction.md(1 hunks)en/identity-server/7.2.0/docs/quick-starts/nodejs.md(2 hunks)en/identity-server/7.2.0/mkdocs.yml(3 hunks)en/identity-server/next/docs/complete-guides/nodejs/accessing-protected-api.md(1 hunks)en/identity-server/next/docs/complete-guides/nodejs/create-a-nodejs-app.md(1 hunks)en/identity-server/next/docs/complete-guides/nodejs/introduction.md(1 hunks)en/identity-server/next/docs/quick-starts/nodejs.md(2 hunks)en/identity-server/next/mkdocs.yml(3 hunks)en/includes/complete-guides/nodejs/accessing-protected-api.md(2 hunks)en/includes/complete-guides/nodejs/create-a-nodejs-app.md(2 hunks)en/includes/complete-guides/nodejs/introduction.md(1 hunks)en/includes/quick-starts/nodejs.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
en/includes/complete-guides/nodejs/introduction.md
[grammar] ~16-~16: Use a hyphen to join words.
Context: ... and logout to your app * Display logged in user detail * Securing routes within ...
(QB_NEW_EN_HYPHEN)
[style] ~20-~20: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1488 characters long)
Context: ...Managing tokens in your Express.js app !!! tip "Tip" This guide takes approxi...
(EN_EXCESSIVE_EXCLAMATION)
🔇 Additional comments (19)
en/identity-server/7.2.0/docs/complete-guides/nodejs/create-a-nodejs-app.md (1)
3-3: LGTM — terminology updated correctly.The heading change properly reflects Express.js as the web framework while the shared include reference is preserved, aligning with the PR objectives across all affected versions.
en/identity-server/7.1.0/docs/quick-starts/nodejs.md (1)
8-8: LGTM — framework and sample naming updated consistently.The what_you_will_learn and source_code label updates correctly reference Express.js (the framework) while retaining Node.js at line 16 for the runtime installation, maintaining the intended distinction throughout the document.
Also applies to: 20-20
en/identity-server/next/docs/complete-guides/nodejs/accessing-protected-api.md (1)
3-3: LGTM — heading updated consistently across versions.The framework reference is correctly updated to Express.js, maintaining alignment with the corresponding 7.1.0 and 7.2.0 versions.
en/identity-server/next/docs/complete-guides/nodejs/introduction.md (1)
12-12: LGTM — sample application terminology updated correctly.The tip content properly references the Express.js sample application while preserving the repository link and configuration guidance, maintaining consistency with other next-version document updates.
en/identity-server/7.1.0/docs/complete-guides/nodejs/accessing-protected-api.md (1)
3-3: LGTM — heading updated consistently across versions.The framework reference is correctly updated to Express.js, maintaining alignment with the corresponding next and 7.2.0 versions.
en/identity-server/7.2.0/docs/quick-starts/nodejs.md (1)
8-8: LGTM — framework and sample naming updated consistently.The what_you_will_learn and source_code label updates correctly reference Express.js (the framework) while retaining Node.js at line 16 for the runtime installation, maintaining the intended distinction throughout the document.
Also applies to: 20-20
en/identity-server/next/docs/complete-guides/nodejs/create-a-nodejs-app.md (1)
3-3: LGTM — heading updated consistently across versions.The framework reference is correctly updated to Express.js, maintaining alignment with the corresponding 7.1.0 and 7.2.0 versions.
en/identity-server/7.1.0/docs/complete-guides/nodejs/create-a-nodejs-app.md (1)
3-3: LGTM — heading updated consistently across versions.The framework reference is correctly updated to Express.js, maintaining alignment with the corresponding next and 7.2.0 versions.
en/identity-server/7.2.0/docs/complete-guides/nodejs/introduction.md (1)
12-12: Approved: Terminology update aligns with framework focus.The change correctly identifies the sample as an Express.js application rather than a generic Node.js application, which better reflects the actual framework being used. The repository link and context remain intact.
en/identity-server/next/docs/quick-starts/nodejs.md (1)
8-8: Approved: Metadata terminology updated correctly.The what_you_will_learn and source_code label changes correctly identify Express.js as the framework. Prerequisites and installation steps correctly retain "Node.js" references for the runtime environment, maintaining accuracy and clarity for developers.
Also applies to: 20-20
en/identity-server/7.2.0/docs/complete-guides/nodejs/accessing-protected-api.md (1)
3-3: Approved: Page heading terminology updated.The front-matter heading change correctly reflects that this guide covers Express.js, consistent with the shared include content. No functional changes to the actual guide content.
en/identity-server/7.1.0/docs/complete-guides/nodejs/introduction.md (1)
12-12: Approved: Version-consistent terminology update.The change mirrors the 7.2.0 update, correctly maintaining consistency across supported versions. Framework identification is now accurate and consistent.
en/includes/complete-guides/nodejs/accessing-protected-api.md (1)
2-4: Approved: Shared include terminology updated comprehensively.Multiple introductory, contextual, and concluding sentences correctly identify Express.js as the framework while preserving all technical code blocks. This shared include update will propagate the consistent terminology across all versions that reference it. No functional changes to code or configuration.
Also applies to: 129-129
en/identity-server/7.2.0/mkdocs.yml (1)
50-51: Approved: Navigation and homepage terminology updated with paths correctly preserved.The mkdocs configuration appropriately updates:
- Home page card display from "Node.js" to "Express.js"
- Navigation section titles and labels from "Node.js" to "Express.js"
- Navigation URLs from "Node.js" to "Express.js" for consistent routing
File paths remain unchanged (quick-starts/nodejs.md, complete-guides/nodejs/) since the directory structure is unchanged—only the framework terminology is updated. This is the correct approach and maintains both clarity and backward-compatible paths.
Also applies to: 490-492, 1349-1353
en/includes/complete-guides/nodejs/create-a-nodejs-app.md (1)
2-4: Approved: Shared include framing updated to reflect Express.js.Introductory and concluding statements correctly identify the scaffolding process as creating an Express.js application. The
npx express-generatorcommand is already Express-specific, so the terminology update improves accuracy without changing any technical instructions.Also applies to: 29-29
en/includes/quick-starts/nodejs.md (1)
1-3: Approved: Comprehensive quickstart guide terminology update.The Express.js Quickstart is properly updated across all sections:
- Title and introduction correctly frame the guide as Express.js-focused
- Example application names updated for clarity (
{{ product }}-expressjs)- Section headings and instructions consistently reference Express.js
- Prerequisites correctly preserve "Node.js" for the runtime environment
- Package manager commands (npm, yarn, pnpm) and authentication flow remain technically unchanged
- Variant instructions (npm/yarn/pnpm) all updated consistently
This shared include will properly serve all referencing versions with clear, accurate terminology.
Also applies to: 13-13, 26-28, 30-65
en/identity-server/next/mkdocs.yml (1)
50-51: Navigation updates from Node.js to Express.js are consistent and correct.The mkdocs.yml changes properly update framework references across home page cards, navigation sections, and technology guides. File paths remain unchanged (quick-starts/nodejs.md, complete-guides/nodejs/introduction.md), which is appropriate since the actual documentation files aren't renamed. The terminology shift is applied consistently across all three locations.
Also applies to: 490-492, 1361-1365
en/includes/complete-guides/nodejs/introduction.md (1)
21-23: Content updates correctly transition terminology from Node.js to Express.js.The introduction now properly refers to Express.js as the framework while preserving Node.js as the runtime ("JavaScript runtime environment"). All references throughout lines 2–19 consistently use Express.js for the application framework, which aligns with the PR objective.
en/identity-server/7.1.0/mkdocs.yml (1)
50-51: Version 7.1.0 navigation updates mirror the "next" version consistently.The changes across all three sections (home page cards, Connect App navigation, and Technology Guides) are structurally identical to those in the "next" version, maintaining consistency across IS versions. Framework terminology correctly updated to Express.js while preserving the nodejs.md file paths.
Also applies to: 485-487, 1264-1268
| * Create an Express.js app from the template | ||
| * Install passport.js and other dependencies | ||
| * Add login and logout to your app | ||
| * Display logged in user detail | ||
| * Securing routes within the app | ||
| * Accessing protected API from your Node.js app | ||
| * Managing tokens in your Node.js app | ||
| * Accessing protected API from your Express.js app | ||
| * Managing tokens in your Express.js app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix grammar issues in the objective list.
Line 16 uses "Display logged in user detail" which should be "Display logged-in user details" (add hyphen and use plural). This aligns with LanguageTool hints and matches the style of other bullet points.
Apply this diff:
- * Display logged in user detail
+ * Display logged-in user details📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * Create an Express.js app from the template | |
| * Install passport.js and other dependencies | |
| * Add login and logout to your app | |
| * Display logged in user detail | |
| * Securing routes within the app | |
| * Accessing protected API from your Node.js app | |
| * Managing tokens in your Node.js app | |
| * Accessing protected API from your Express.js app | |
| * Managing tokens in your Express.js app | |
| * Create an Express.js app from the template | |
| * Install passport.js and other dependencies | |
| * Add login and logout to your app | |
| * Display logged-in user details | |
| * Securing routes within the app | |
| * Accessing protected API from your Express.js app | |
| * Managing tokens in your Express.js app |
🧰 Tools
🪛 LanguageTool
[grammar] ~16-~16: Use a hyphen to join words.
Context: ... and logout to your app * Display logged in user detail * Securing routes within ...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
en/includes/complete-guides/nodejs/introduction.md around lines 13 to 19: the
objective list has a grammar/style issue on line 16; change "Display logged in
user detail" to "Display logged-in user details" (add hyphen and pluralize
"detail") so it matches style and LanguageTool suggestions and aligns with the
other bullet points.
This PR was automatically generated by Claude AI.
Changes Made
Affected Versions
All documentation updates have been applied to the following versions in a single PR:
Files Changed
Shared Include Files (affects all versions):
en/includes/quick-starts/nodejs.mden/includes/complete-guides/nodejs/introduction.mden/includes/complete-guides/nodejs/create-a-nodejs-app.mden/includes/complete-guides/nodejs/accessing-protected-api.mdVersion-Specific Files:
Each of the three versions (7.1.0, 7.2.0, next) had the following files updated:
docs/quick-starts/nodejs.md(metadata)docs/complete-guides/nodejs/create-a-nodejs-app.md(heading)docs/complete-guides/nodejs/accessing-protected-api.md(heading)docs/complete-guides/nodejs/introduction.md(tip section)mkdocs.yml(navigation menu items)Verification
mkdocs buildSummary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.