Clarify CLI log parameters

Open
#2,033 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by locating the CLI parameter definitions and the existing logging documentation or help text. Update the names and descriptions to distinguish system logs, and document that information about the current run appears in stdout; done when the CLI help and related text remove the ambiguity.

Written by the indexing model from the issue text.

Description

There was some confusion recently over what logs appear where, and the CLI parameters to configure the log location added to this confusion. Let's improve the naming and descriptions of these parameters to make it obvious that they are system logs. Maybe we can also add some text somewhere that info about the current run will appear in stdout.

┆Issue is synchronized with this Jira Task

Dominant language
Python
Stars
26
Forks
14
Avg merge
19h 55m
Merged PRs (30d)
9

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 mozilla/jetstream

All issues in mozilla/jetstream

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.