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 documentation for open-logs command in the troubleshooting section #239

Open
2 tasks
ImmaZoni opened this issue Sep 1, 2023 · 0 comments
Open
2 tasks
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@ImmaZoni
Copy link
Contributor

ImmaZoni commented Sep 1, 2023

Description:

The Pulsar project offers a handy open-logs command that opens the log directory directly in the OS's file explorer. This feature can be extremely useful for users when troubleshooting issues. However, it seems this command is not yet documented in our troubleshooting section.

Task:

  • Add a description and usage example of the open-logs command to the troubleshooting section of our documentation.
  • Mention any common scenarios/usecases where this command might be particularly useful.

Additional Information:

  • This can be a great opportunity for community members who are new to the project or looking for a 'good first issue' to tackle.
  • For reference or any questions, please feel free to comment and discuss
@ImmaZoni ImmaZoni added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant