Skip to content

Commit

Permalink
Make slack more prominent (#846)
Browse files Browse the repository at this point in the history
Co-authored-by: ChristopherGS <chris@pydantic.dev>
  • Loading branch information
ChristopherGS and ChristopherGS authored Feb 7, 2025
1 parent 51fb7b1 commit da4bb38
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 15 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
# Pydantic Logfire — Uncomplicated Observability

[![CI](https://github.com/pydantic/logfire/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/pydantic/logfire/actions?query=event%3Apush+branch%3Amain+workflow%3ACI)
[![codecov](https://codecov.io/gh/pydantic/logfire/graph/badge.svg?token=735CNGCGFD)](https://codecov.io/gh/pydantic/logfire)
[![pypi](https://img.shields.io/pypi/v/logfire.svg)](https://pypi.python.org/pypi/logfire)
[![license](https://img.shields.io/github/license/pydantic/logfire.svg)](https://github.com/pydantic/logfire/blob/main/LICENSE)
[![versions](https://img.shields.io/pypi/pyversions/logfire.svg)](https://github.com/pydantic/logfire)
<p align="center">
<a href="https://github.com/pydantic/logfire/actions?query=event%3Apush+branch%3Amain+workflow%3ACI">
<img src="https://github.com/pydantic/logfire/actions/workflows/main.yml/badge.svg?event=push" alt="CI" />
</a>
<a href="https://codecov.io/gh/pydantic/logfire">
<img src="https://codecov.io/gh/pydantic/logfire/graph/badge.svg?token=735CNGCGFD" alt="codecov" />
</a>
<a href="https://pypi.python.org/pypi/logfire">
<img src="https://img.shields.io/pypi/v/logfire.svg" alt="pypi" />
</a>
<a href="https://github.com/pydantic/logfire/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/pydantic/logfire.svg" alt="license" />
</a>
<a href="https://github.com/pydantic/logfire">
<img src="https://img.shields.io/pypi/pyversions/logfire.svg" alt="versions" />
</a>
<a href="https://logfire.pydantic.dev/docs/help/">
<img src="https://img.shields.io/badge/Slack-Join%20Slack-4A154B?logo=slack" alt="Join Slack" />
</a>
</p>

From the team behind Pydantic, **Logfire** is an observability platform built on the same belief as our
open source library — that the most powerful tools can be easy to use.
Expand Down
8 changes: 5 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Pydantic Logfire
# Getting Started

## About Logfire

From the team behind **Pydantic**, **Logfire** is a new type of observability platform built on
the same belief as our open source library — that the most powerful tools can be easy to use.

**Logfire** is built on OpenTelemetry, and supports monitoring your application from any language,
**Logfire** is built on OpenTelemetry, and supports monitoring your application from **any language**,
with particularly great support for Python! [Read more](why.md).

## Getting Started
## Overview

This page is a quick walk-through for setting up a Python app:

Expand Down
5 changes: 0 additions & 5 deletions docs/plugins/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ def install_logfire(markdown: str, page: Page) -> str:
# Split them and strip quotes for each one separately.
extras = [arg.strip('\'"') for arg in arguments[1].strip('[]').split(',')] if len(arguments) > 1 else []
package = 'logfire' if not extras else f"'logfire[{','.join(extras)}]'"
extras_arg = ' '.join(f'-E {extra}' for extra in extras)
instructions = [
'=== "pip"',
' ```bash',
Expand All @@ -102,10 +101,6 @@ def install_logfire(markdown: str, page: Page) -> str:
' ```bash',
f' uv add {package}',
' ```',
'=== "rye"',
' ```bash',
f' rye add logfire {extras_arg}',
' ```',
'=== "poetry"',
' ```bash',
f' poetry add {package}',
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,11 @@ extra_javascript:
- "/flarelytics/client.js"

nav:
- Logfire:
- Getting Started:
- Logfire: index.md
- Why Logfire?: why.md
- Concepts: concepts.md
- Join Slack: help.md
- Onboarding Checklist:
- Onboarding Checklist: guides/onboarding-checklist/index.md
- Integrate Logfire: guides/onboarding-checklist/integrate.md
Expand Down Expand Up @@ -148,7 +149,6 @@ nav:
- Propagate: reference/api/propagate.md
- Exceptions: reference/api/exceptions.md
- Pydantic: reference/api/pydantic.md
- Help: help.md
- Roadmap: roadmap.md
- Release Notes: release-notes.md

Expand Down

0 comments on commit da4bb38

Please sign in to comment.