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

Revamp logging documentation for 0.19 #2664

Closed
1 of 4 tasks
noklam opened this issue Jun 9, 2023 · 1 comment · Fixed by #2665
Closed
1 of 4 tasks

Revamp logging documentation for 0.19 #2664

noklam opened this issue Jun 9, 2023 · 1 comment · Fixed by #2665
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@noklam
Copy link
Contributor

noklam commented Jun 9, 2023

Description

This is a follow-up ticket to update the documentation. Since there are many changes in logging, it makes sense to look at the whole logging documentation. Splitting this from #2642 since the PR is getting too large.

Some changes we made:

This could affect our logging.md and some of the deployment docs and more. The best way to do it is go through the RELEASE.md we have made in the last couple of months and check the closed milestone ticket

Checklist

Also this:

This is a huge improvement, thank you! 🙏 I would recommend picking up #2520 next so then we've got all the logging code changes complete and then write the docs after that.

When it comes to writing docs, we should be able to make the page MUCH simpler. Basically it would be something like:

  1. By default kedro, uses rich for logging. For the full setup, look at the default_logging.yml file
  2. If you want to change this then make your own logging.yml file. We recommend you put that file in conf. Then set KEDRO_CONFIG_LOGGING environment variable to point to it
  3. Show some of the things you might like to change and the code needed to do it:
    a. Turn off rich tracebacks
    b. Turn on file logging
    c. Show DEBUG level messages

No need to explain the difference between framework-side and logging-side configuration or any of that confusing stuff any more 🎉

Originally posted by @antonymilne in #2642 (review)

Follow-up

@noklam noklam linked a pull request Jun 9, 2023 that will close this issue
5 tasks
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Jun 12, 2023
@noklam noklam self-assigned this Jun 12, 2023
@noklam
Copy link
Contributor Author

noklam commented Jul 4, 2023

Closed by #2665

@noklam noklam closed this as completed Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants