Skip to content

chore: update links in readme #1344

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

Merged
merged 1 commit into from
Jun 11, 2025
Merged

chore: update links in readme #1344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
[![Docs](https://img.shields.io/badge/stable%20docs-parseable.com%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://logg.ing/docs)
[![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions)

[Key Concepts](https://www.parseable.com/docs/concepts) | [Features](https://github.com/parseablehq/parseable#rocket-highlights) | [Documentation](https://www.parseable.com/docs) | [Demo](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [FAQ](https://www.parseable.com/docs/faq)
[Key Concepts](https://www.parseable.com/docs/key-concepts) | [Features](https://www.parseable.com/docs/features/alerts) | [Documentation](https://www.parseable.com/docs) | [Demo](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [FAQ](https://www.parseable.com/docs/key-concepts/data-model#faq)

</div>

Expand All @@ -26,7 +26,7 @@ To experience Prism(Parseable UI), checkout [demo.parseable.com ↗︎](https://
### Run ParseableDB

<details>
<summary><a href="https://www.parseable.com/docs/server/get-started/docker-quick-start">Docker Image</a></summary>
<summary><a href="https://www.parseable.com/docs/quickstart/docker">Docker Image</a></summary>
<p>

Get started with ParseableDB Docker with a single command:
Expand All @@ -41,7 +41,7 @@ docker run -p 8000:8000 \
</details>

<details>
<summary><a href="https://www.parseable.com/docs/server/get-started/binary-quick-start">Executable Binary</a></summary>
<summary><a href="https://www.parseable.com/docs/quickstart/binary">Executable Binary</a></summary>
<p>

Download and run the ParseableDB binary on your laptop:
Expand Down Expand Up @@ -87,18 +87,17 @@ For quickstart, refer the [quickstart section ↗︎](#quickstart-zap).

This section elaborates available options to run ParseableDB in production or development environments.

- Distributed ParseableDB on Kubernetes: [Helm Installation](https://www.parseable.com/docs/server/installation/distributed/setup-distributed-parseable-on-kubernetes-via-helm).
- Distributed ParseableDB on AWS EC2 / VMs / Linux: [Binary Installation](https://www.parseable.com/docs/server/installation/distributed/setup-systemd-service-for-distributed-parseable-server).
- Distributed ParseableDB on Kubernetes: [Helm Installation](https://www.parseable.com/docs/installation/distributed/k8s-helm).
- Distributed ParseableDB on AWS EC2 / VMs / Linux: [Binary Installation](https://www.parseable.com/docs/installation/distributed/linux).

## Features :rocket:

- [High availability & Cluster mode ↗︎](https://www.parseable.com/docs/concepts/distributed-architecture)
- [Hot Tier ↗︎](https://www.parseable.com/docs/features/tiering)
- [Alerts ↗︎](https://www.parseable.com/docs/alerts)
- [Role based access control ↗︎](https://www.parseable.com/docs/rbac)
- [OAuth2 support ↗︎](https://www.parseable.com/docs/oidc)
- [LLM integration ↗︎](https://www.parseable.com/docs/integrations/llm-based-sql-generation)
- [OpenTelemetry support ↗︎](https://www.parseable.com/docs/opentelemetry)
- [High availability & Cluster mode ↗︎](https://www.parseable.com/docs/key-concepts/high-availability)
- [Smart cache ↗︎](https://www.parseable.com/docs/features/smart-cache)
- [Alerts ↗︎](https://www.parseable.com/docs/features/alerts)
- [Role based access control ↗︎](https://www.parseable.com/docs/features/rbac)
- [OAuth2 support ↗︎](https://www.parseable.com/docs/features/oepnid)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Broken OAuth2 docs link.
The path segment oepnid appears to be a typo. It should likely read openid (e.g., /docs/features/openid).

-[OAuth2 support ↗︎](https://www.parseable.com/docs/features/oepnid)
+[OAuth2 support ↗︎](https://www.parseable.com/docs/features/openid)
📝 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.

Suggested change
- [OAuth2 support ↗︎](https://www.parseable.com/docs/features/oepnid)
- [OAuth2 support ↗︎](https://www.parseable.com/docs/features/openid)
🤖 Prompt for AI Agents 
In README.md at line 99, the OAuth2 support link contains a typo in the URL path
segment "oepnid". Correct the URL by changing "oepnid" to "openid" so the link
points to the proper documentation path "/docs/features/openid".

- [OpenTelemetry support ↗︎](https://www.parseable.com/docs/OpenTelemetry/logs)

## How do people use Parseable :bulb:

Expand Down Expand Up @@ -126,4 +125,4 @@ gh attestation verify PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY -R parseablehq/pars

<a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>

[Contribution guide ↗︎](https://www.parseable.com/docs/contributing)
[Contribution guide ↗︎](https://github.com/parseablehq/parseable/blob/main/CONTRIBUTING.md)