Skip to content

docs: Add Slack community invite badge to home page README. #1418

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 5 commits into from
Oct 17, 2025
Merged

docs: Add Slack community invite badge to home page README. #1418

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7d63747
Add Slack invite button to README.md
AVMatthews Oct 14, 2025
aef86bd
Change colors of badge
AVMatthews Oct 16, 2025
bb51481
Standardize badge label hex ccolors
AVMatthews Oct 16, 2025
cfeb04d
Merge branch 'main' into slackButton
AVMatthews Oct 17, 2025
9b3732d
Merge branch 'main' into slackButton
AVMatthews Oct 17, 2025
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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Open bug reports](https://img.shields.io/github/issues/y-scope/clp/bug?label=bugs)](https://github.com/y-scope/clp/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
[![Open feature requests](https://img.shields.io/github/issues/y-scope/clp/enhancement?label=feature-requests)](https://github.com/y-scope/clp/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
[![Discord][badge-discord]][yscope-community-discord]
[![Slack][badge-slack]][yscope-community-slack]
[![CLP on Zulip][badge-zulip]][yscope-community-zulip]

YScope's Compressed Log Processor (CLP) compresses your logs, and allows you to search the
Expand Down Expand Up @@ -89,14 +90,16 @@ You can use GitHub issues to [report a bug][bug-report] or [request a feature][f
Need help? Join us on one of our community servers:

* [![Discord][badge-discord]][yscope-community-discord]
* [![Slack][badge-slack]][yscope-community-slack]
Copy link
Member

Choose a reason for hiding this comment

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

let's also add this to

clp/docs/src/index.md

Lines 100 to 105 in 56ebca1

## Community
Need help? Join us on one of our community servers:
* [![Discord][badge-discord]][yscope-community-discord]
* [![CLP on Zulip][badge-zulip]][yscope-community-zulip]

@coderabbitai create an issue

Copy link
Contributor

Choose a reason for hiding this comment

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

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash

# First, let's check the current content of the docs/src/index.md file around lines 100-105
echo "=== Current content of docs/src/index.md around lines 100-105 ==="
cat docs/src/index.md | sed -n '95,110p' | nl -v 95

echo ""
echo "=== Creating GitHub issue ==="

# Create the issue
gh issue create \
  --title "docs: Add Slack community invite badge to documentation site index" \
  --body "## Description

Add the Slack community invite badge to the documentation site's index page (\`docs/src/index.md\`) to match the badge added to the main README.

## Context

The Slack badge was added to the main README.md in PR #1418. For consistency, it should also be added to the documentation site index at the community links section (around lines 100-105).

## Reference

- File: \`docs/src/index.md\`
- Location: https://github.com/y-scope/clp/blob/56ebca1ea4dcf4bd50a20a35197dd7b502f42f86/docs/src/index.md?plain=1#L100-L105
- Related PR: #1418
- Related comment: https://github.com/y-scope/clp/pull/1418#discussion_r2471728685

## Badge Details

Use the same badge configuration as in README.md:
- Badge markdown: \`[![Slack][badge-slack]][yscope-community-slack]\`
- Badge definition: \`[badge-slack]: https://img.shields.io/badge/Slack-yscope--community-1e724f?style=flat&logo=slack&logoColor=white&labelColor=4A154B\`
- Link definition: \`[yscope-community-slack]: https://communityinviter.com/apps/yscopecommunity/yscope-community\`

Requested by: @junhaoliao" \
  --assignee junhaoliao

Length of output: 180

@junhaoliao, I've created issue #1520 to track adding the Slack community badge to docs/src/index.md. The issue includes:

You can view the issue here: #1520

* [![CLP on Zulip][badge-zulip]][yscope-community-zulip]

# Next Steps

This is our open-source release which we will be constantly updating with bug fixes, features, etc.
If you would like a feature or want to report a bug, please file an issue and we'll be happy to engage.

[badge-discord]: https://img.shields.io/discord/1377353873068392580?style=flat&logo=discord&logoColor=white&label=Discord&labelColor=%235561f5
[badge-discord]: https://img.shields.io/discord/1377353873068392580?style=flat&logo=discord&logoColor=white&label=Discord&labelColor=5561f5
[badge-slack]: https://img.shields.io/badge/Slack-yscope--community-1e724f?style=flat&logo=slack&logoColor=white&labelColor=4A154B
[badge-zulip]: https://img.shields.io/badge/Zulip-yscope--clp-1888FA?logo=zulip
[bug-report]: https://github.com/y-scope/clp/issues/new?assignees=&labels=bug&template=bug-report.yml
[build-package]: http://docs.yscope.com/clp/main/dev-docs/building-package
Expand All @@ -118,4 +121,5 @@ If you would like a feature or want to report a bug, please file an issue and we
[re2]: https://github.com/google/re2
[uber-blog]: https://www.uber.com/en-US/blog/reducing-logging-cost-by-two-orders-of-magnitude-using-clp
[yscope-community-discord]: https://discord.gg/7kZA2m5G87
[yscope-community-slack]: https://communityinviter.com/apps/yscopecommunity/yscope-community
[yscope-community-zulip]: https://yscope-clp.zulipchat.com
Loading