update readme #1417
update readme #1417
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughREADME.md is revised to update branding from ParseableDB to Parseable, adjust demo/login URL, add a YouTube embed, rename and tweak Quickstart with new Docker image reference, update deployment wording/links, and remove usage/motivation sections. No code or API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
✨ 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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 (9)
README.md (9)
20-20: Grammar and style: “full stack” → “full-stack”; “checkout” → “check out”.Tighten copy and avoid minor grammatical nits.
-Parseable is a full stack observability platform built to ingest, analyze and extract insights from all types of telemetry (MELT) data. You can run Parseable on your local machine, in the cloud, or as a managed service. To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login). +Parseable is a full-stack observability platform built to ingest, analyze, and extract insights from all types of telemetry (MELT) data. You can run Parseable on your local machine, in the cloud, or as a managed service. To experience the Parseable UI, check out [demo.parseable.com ↗︎](https://demo.parseable.com/login).
22-26: Use HTTPS, add rel="noopener noreferrer", and prefer privacy-enhanced YouTube.Avoid mixed-content warnings and add security attributes for target=_blank. Also drop the obsolete border attribute and use a higher-res thumbnail.
-<h2 align="center"> -<a href="http://www.youtube.com/watch?feature=player_embedded&v=gYn3pFAfrVA" target="_blank"> - <img src="http://img.youtube.com/vi/gYn3pFAfrVA/mqdefault.jpg" alt="Watch the video" width="240" height="180" border="10" /> -</a> -</h2> +<h2 align="center"> +<a href="https://www.youtube-nocookie.com/watch?v=gYn3pFAfrVA" target="_blank" rel="noopener noreferrer"> + <img src="https://img.youtube.com/vi/gYn3pFAfrVA/hqdefault.jpg" alt="Watch the video" width="480" height="270" /> +</a> +</h2>
5-5: Add rel="noopener noreferrer" to external link opened in a new tab.Minor security hardening for the logo link.
- <a href="https://www.parseable.com" target="_blank"><img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg" alt="Parseable logo" /></a> + <a href="https://www.parseable.com" target="_blank" rel="noopener noreferrer"><img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg" alt="Parseable logo" /></a>
36-36: Minor copy tweak (also flagged by LanguageTool).Readability: add article and prefer “using” over “with”.
-Get started with Parseable Docker image with a single command: +Get started with the Parseable Docker image using a single command:
73-76: Avoid hardcoding Base64 credentials; let curl set the Authorization header.Keeps the example clearer and avoids exposing encoded credentials. Also makes it easier for users to swap creds.
-curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ ---header 'X-P-Stream: demo' \ ---header 'Authorization: Basic YWRtaW46YWRtaW4=' \ ---header 'Content-Type: application/json' \ +curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ +--header 'X-P-Stream: demo' \ +--header 'Content-Type: application/json' \ +-u admin:admin \ --data-raw '[Follow-up: If Basic auth can be disabled locally, consider showing an auth-free example first, then a secured variant.
70-70: Copy tweak: “below command” → “the following command”.Micro-clarity improvement.
-Once you have Parseable running, ingest data with the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard. +Once you have Parseable running, ingest data with the following command. This sends logs to the `demo` stream; you can view them in the dashboard.
86-86: Grammar and clarity for login sentence; add a brief security note.Use “log in” (verb) and clarify credentials.
-Access the UI at [http://localhost:8000 ↗︎](http://localhost:8000). You can login to the dashboard default credentials `admin`, `admin`. +Access the UI at [http://localhost:8000 ↗︎](http://localhost:8000). You can log in with the default credentials: `admin` / `admin`. For production, change the admin password immediately.
13-14: Docs badge label vs. link domain mismatch.The badge text advertises parseable.com/docs, but the link targets logg.ing/docs. If parseable.com is now canonical (as used elsewhere in this README), align the link.
-[](https://logg.ing/docs) +[](https://www.parseable.com/docs)
39-42: Optional: show a persistence variant with a volume mount.Quickstart currently runs ephemeral storage. Consider a second snippet that persists data between restarts to reduce support churn from first-time users.
Example (add below the existing snippet, not replacing it):
docker run -p 8000:8000 \ -v $PWD/parseable-data:/var/lib/parseable \ parseable/parseable:latest \ parseable local-store --data-dir /var/lib/parseableHappy to add this as a second example if you want it in this PR.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-01T08:52:30.303Z
Learnt from: nitisht
PR: parseablehq/parseable#1397
File: scripts/download.sh:6-11
Timestamp: 2025-08-01T08:52:30.303Z
Learning: The parseablehq/parseable project uploads release assets as raw binary executables without file extensions, not as compressed archives. The download script correctly downloads these binaries directly and makes them executable with chmod +x.
Applied to files:
README.md
📚 Learning: 2025-08-01T09:01:14.693Z
Learnt from: nitisht
PR: parseablehq/parseable#1397
File: scripts/download.sh:5-6
Timestamp: 2025-08-01T09:01:14.693Z
Learning: The parseablehq/parseable project uses separate download scripts for different platforms - there's a dedicated Windows script, so the main download.sh script in scripts/download.sh is only intended for Unix-like systems (Linux and macOS).
Applied to files:
README.md
🪛 LanguageTool
README.md
[grammar] ~36-~36: There might be a mistake here.
Context: ...er Image
Get started with Parseable Docker image with a single co...
(QB_NEW_EN)
🔇 Additional comments (2)
README.md (2)
16-16: Top nav looks good; ensure “Features” deep link is stable.If the alerts page slug changes often, consider linking to the Features index and using in-page anchors. Otherwise, LGTM.
99-105: Ignore the suggested link changesI verified the live URLs:
- The “OAuth2 support” link (…/docs/features/oepnid) returns HTTP 200, while changing it to “openid” or “oauth2” yields 404.
- The “OpenTelemetry support” link must keep its uppercase path; the lowercase variant returns 404, and the current URL responds with HTTP 200.
No updates to these links are needed in README.md. Please disregard the previous suggestions.
Likely an incorrect or invalid review comment.
1 participant
Summary by CodeRabbit