stdlib and structlog on separate URLs

Open
#72 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the installation.html page and its #structlog section linked in the issue. Separate the stdlib and structlog setup guidance into distinct documentation pages, then verify that the installation links and headings clearly direct readers to the intended setup.

Written by the indexing model from the issue text.

Description

agent-python community triage

I recently advised a developer to add ecs_logging.StructlogFormatter() to our project. However he managed to use the stdlib code because they are on same page.

I propose that stdlib setup and structlog setup should be separate pages in the documentation to avoid this confusion.

https://www.elastic.co/guide/en/ecs-logging/python/current/installation.html#structlog

Also thank you for your great products!

Dominant language
Python
Stars
74
Forks
33
Avg merge
9h 3m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/ecs-logging-python

All issues in elastic/ecs-logging-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.