Readme examples minor #2034
Readme examples minor #2034
Conversation
# Conflicts: # core/src/main/java/com/predic8/membrane/core/interceptor/apikey/stores/JDBCApiKeyStore.java
|
Warning Rate limit exceeded@predic8 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 42 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
WalkthroughDocumentation files were updated for clarity, consistency, and improved formatting. Changes include revised section headers, corrected links, streamlined instructions, and removal of outdated roadmap tasks. No code, APIs, or functional behavior were modified; all updates are limited to markdown files and content presentation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
distribution/examples/security/README.md (1)
8-9: Indent nested bullets to satisfy markdown-lint (MD007)
markdownlint flags the current two-space indent. Four spaces (or a tab) avoids the warning and renders consistently across viewers.- * Use different OAuth2 flows with APIs - * Authentication and authorization with JWT, OAuth2 and OpenID Connect + * Use different OAuth2 flows with APIs + * Authentication and authorization with JWT, OAuth2 and OpenID ConnectREADME.md (1)
144-157: Fix numbering gap and list-item indentation in Java install steps
- Step
3.is missing (sequence jumps from 2 → 4).- Sub-bullets are indented with two spaces, violating MD007 and rendering inconsistently.
1. **Download and extract** - - [Download a release](https://github.com/membrane/api-gateway/releases) and unzip it. + - [Download a release](https://github.com/membrane/api-gateway/releases) and unzip it. 2. **Start the Gateway** - - Open a terminal in the extracted folder. - - Make sure Java 21 or newer is installed: + - Open a terminal in the extracted folder. + - Make sure Java 21 or newer is installed: ```bash java -version ``` - - Start: + - Start: - **Linux/Mac:** `./membrane.sh` - **Windows:** `membrane.cmd` -4. **Access the Gateway** - - Open [http://localhost:2000](http://localhost:2000) -5. **Change the Configuration** - Modify the preconfigured APIs or add APIs by editing the `proxies.xml` file in the `conf` folder. +3. **Access the Gateway** + - Open [http://localhost:2000](http://localhost:2000) +4. **Change the Configuration** + - Modify the preconfigured APIs or add APIs by editing the `proxies.xml` file in the `conf` folder.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/images/api-gateway-ebook-cover.jpgis excluded by!**/*.jpg
📒 Files selected for processing (5)
README.md(7 hunks)distribution/examples/README.md(1 hunks)distribution/examples/extending-membrane/README.md(1 hunks)distribution/examples/security/README.md(1 hunks)docs/ROADMAP.md(0 hunks)
💤 Files with no reviewable changes (1)
- docs/ROADMAP.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: when using environment variable shortcuts like `$membrane_home` in shell scripts that look for insta...
Learnt from: rrayst
PR: membrane/api-gateway#1947
File: distribution/tutorials/soap/membrane.sh:17-22
Timestamp: 2025-07-02T18:05:47.059Z
Learning: When using environment variable shortcuts like `$MEMBRANE_HOME` in shell scripts that look for installation directories, validate that required files (like `starter.jar` for Membrane) exist in the candidate directory before returning it. This prevents hard-to-diagnose runtime errors when the environment variable points to an invalid or stale location.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.17.2)
README.md
145-145: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
147-147: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
148-148: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
152-152: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
153-153: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
154-154: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
156-156: Unordered list indentation
Expected: 0; Actual: 2
(MD007, ul-indent)
🔇 Additional comments (3)
distribution/examples/extending-membrane/README.md (1)
3-4: Intro sentence looks good – no action needed
The added clarification is concise and helpful without altering existing structure.distribution/examples/README.md (1)
74-79: Links conversion LGTM
Turning plain headers into links improves navigation.README.md (1)
1090-1100: Prometheus note reads well – no changes necessary
The added sentence and reference link are clear and accurate.
|
This pull request needs "/ok-to-test" from an authorized committer. |
3 participants
Summary by CodeRabbit