Skip to content
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.

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

add(docs): Note default path to config in docs #8143

Merged
merged 4 commits into from
Jan 10, 2024
Merged

add(docs): Note default path to config in docs #8143

merged 4 commits into from
Jan 10, 2024

Conversation

arya2
Copy link
Contributor

@arya2 arya2 commented Jan 8, 2024

Motivation

This PR makes it easier to find docs about the default config paths for macOS and Windows.

Closes #7964.

PR Author Checklist

Check before marking the PR as ready for review:

  • Will the PR name make sense to users?
  • Does the PR have a priority label?
  • Have you added or updated tests?
  • Is the documentation up to date?
For significant changes:
  • Is there a summary in the CHANGELOG?
  • Can these changes be split into multiple PRs?

If a checkbox isn't relevant to the PR, mark it as done.

Solution

Adds a note to the README, zebrad docs, ZebradConfig docs, and generate command output with a link to default path to preferences directory for macOS/Windows.

Review

Anyone can review.

Reviewer Checklist

Check before approving the PR:

  • Does the PR scope match the ticket?
  • Are there enough tests to make sure it works? Do the tests cover the PR motivation?
  • Are all the PR blockers dealt with?
    PR blockers can be dealt with in new tickets or PRs.

And check the PR Author checklist is complete.

@arya2 arya2 added A-docs Area: Documentation P-Medium ⚡ I-usability Zebra is hard to understand or use labels Jan 8, 2024
@arya2 arya2 self-assigned this Jan 8, 2024
@arya2 arya2 requested a review from a team as a code owner January 8, 2024 22:37
@arya2 arya2 requested review from upbqdn and removed request for a team January 8, 2024 22:37
upbqdn
upbqdn previously approved these changes Jan 9, 2024
Copy link
Contributor

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

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

Just some things I noticed in a quick skim.

Copy link
Contributor

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

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

Thanks!

teor2345
teor2345 previously approved these changes Jan 10, 2024
Copy link
Contributor

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

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

Thanks!

mergify bot added a commit that referenced this pull request Jan 10, 2024
@mergify mergify bot merged commit 81a3a2a into main Jan 10, 2024
180 checks passed
@mergify mergify bot deleted the doc-config-dir branch January 10, 2024 06:53
@oxarbitrage oxarbitrage mentioned this pull request Jan 17, 2024
41 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation I-usability Zebra is hard to understand or use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc bug: macOS zebrad.toml path is hard to find in the docs
3 participants