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

Document the Use of the log Sub-Command in the README.md #22

Closed
gkapfham opened this issue Aug 24, 2023 · 3 comments
Closed

Document the Use of the log Sub-Command in the README.md #22

gkapfham opened this issue Aug 24, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@gkapfham
Copy link
Collaborator

Right now the README.md command does not explain how to the chasten log that
starts the syslog server. This documentation will need to explain what is a
syslog server, which it is useful to have a syslog server, and then given an
overview of the kind of output that chasten's syslog server provides.

@churd01 churd01 self-assigned this Sep 8, 2023
@simojo simojo added the documentation Improvements or additions to documentation label Sep 8, 2023
@gkapfham
Copy link
Collaborator Author

Hi @churd01 I see that you are assigned to this issue. Can you please give us a status update?

@gkapfham
Copy link
Collaborator Author

Hi @churd01, have you gotten the log feature to work? Please note that you will need to startup the logging server in one terminal window and then run chasten so that it sends logging information to that logging server.

It is also worth noting that it is possible to use the run chasten and configure it so that it displays logging information in its own terminal when it is running. The documentation that you create should also reflect this feature as well.

Finally, and most importantly, it is worth thinking about whether this documentation is most useful for developers or for people who are going to use the tool. Depending on your audience, where do you think that it is best for the documentation to appear?

@KellerLiptrap KellerLiptrap self-assigned this Sep 12, 2023
@KellerLiptrap
Copy link
Collaborator

Resolved in #70

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
Projects
None yet
Development

No branches or pull requests

5 participants