Skip to content

docs: logging#821

Merged
tusharmath merged 7 commits intotailcallhq:mainfrom
melsonic:add-logging-doc
Dec 29, 2023
Merged

docs: logging#821
tusharmath merged 7 commits intotailcallhq:mainfrom
melsonic:add-logging-doc

Conversation

@melsonic
Copy link
Copy Markdown
Contributor

@melsonic melsonic commented Dec 28, 2023

Summary:
In this PR, detailed documentation on logging is added. I have added information about different log levels and how to configure them. I have also added one diagram.

Issue Reference(s):
Fixes #809
/claim #809

@melsonic
Copy link
Copy Markdown
Contributor Author

melsonic commented Dec 28, 2023

@tusharmath let me know if anything still needs to be added.


And one more thing I would like to add to this documentation if you allow me to do so. Here is an image that shows a practical implementation of different log levels. Can I add this one also in the documentation?





I didn't add this image in the first place because this program is not a part of tailcall. I just wrote it while understanding different log levels myself.

@tusharmath
Copy link
Copy Markdown
Contributor

Just pass the doc thru grammarly. There are a few punctuation issues.

A image can be added, but it should be from Tailcall. How about a hero image?

@tusharmath
Copy link
Copy Markdown
Contributor

I like the overall content. It could though emphasize a little bit on how Tailcall leverages these levels to improve devex.

@melsonic
Copy link
Copy Markdown
Contributor Author

Just pass the doc thru grammarly. There are a few punctuation issues.

A image can be added, but it should be from Tailcall. How about a hero image?

Sure, I will correct those punctuation errors.
And for the image part, I have already added one called logging.png. Can you check that one and let me know if that's ok?

@amitksingh1490 amitksingh1490 added the ci: lint Automatically fix the linters issues and make a commit label Dec 29, 2023
@tusharmath
Copy link
Copy Markdown
Contributor

@melsonic Yes, the image is good. We generally design artwork in canvas.excalidraw. Would be even better if you could use that though I would not mind the author take some creative liberty here :-)

@melsonic
Copy link
Copy Markdown
Contributor Author

@melsonic Yes, the image is good. We generally design artwork in canvas.excalidraw. Would be even better if you could use that though I would not mind the author take some creative liberty here :-)

I created the image using Excalidraw but was unsure how to directly link it to the document. So, I exported it as a JPG file and added the image in that logging.md file.

I have added the diagram to canvas.excalidraw file. I will add that in the next commit. Are there any additional steps I should take to properly link the image?

@tusharmath tusharmath removed the ci: lint Automatically fix the linters issues and make a commit label Dec 29, 2023
@tusharmath
Copy link
Copy Markdown
Contributor

I think the image in SVG doesn't get the right fonts. Let's use png in this case.

@melsonic
Copy link
Copy Markdown
Contributor Author

I think the image in SVG doesn't get the right fonts. Let's use png in this case.

Added png image 👍
Please confirm if something still needs to be changed/added.

@tusharmath tusharmath enabled auto-merge (squash) December 29, 2023 13:30
@tusharmath tusharmath disabled auto-merge December 29, 2023 13:30
@tusharmath tusharmath merged commit cc1ed6a into tailcallhq:main Dec 29, 2023
@algora-pbc algora-pbc bot mentioned this pull request Dec 29, 2023
@tusharmath
Copy link
Copy Markdown
Contributor

/approve

@algora-pbc
Copy link
Copy Markdown

algora-pbc bot commented Dec 29, 2023

@tusharmath: The claim has been successfully added to reward-all. You can visit your dashboard to complete the payment.

@amitksingh1490 amitksingh1490 added the type: docs Related to documentation and information. label Jan 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🙋 Bounty claim type: docs Related to documentation and information.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write a guide on Logging

3 participants