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

[v1.17] Update Docs to new Debug mode handling and .env support #143

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

gevorgmansuryan
Copy link
Contributor

@gevorgmansuryan gevorgmansuryan self-assigned this Sep 2, 2024
@luke- luke- changed the title Update Docs to new Debug mode handling and .env support [v1.17] Update Docs to new Debug mode handling and .env support Sep 2, 2024
@luke-
Copy link
Contributor

luke- commented Sep 2, 2024

@gevorgmansuryan Thanks

@mbumpalumpa Can you please review?

Maybe we add a Enable debug mode section on this page
https://docs.humhub.org/docs/admin/troubleshooting and link to it?

@luke- luke- requested a review from mbumpalumpa September 2, 2024 08:03
@luke- luke- assigned mbumpalumpa and unassigned gevorgmansuryan Sep 2, 2024
@luke- I'm a bit confused about the usage of backticks, as we use both single and double backticks in different places. I changed the ones I saw to double backticks, as most of the previous commits (from 4 years ago) use double backticks.
@luke-
Copy link
Contributor

luke- commented Sep 4, 2024

@mbumpalumpa Thanks looks good.

Do you think we should perhaps include logging and debug mode here?
https://docs.humhub.org/docs/admin/troubleshooting

@luke- something like this? Idk if this is the right place within the Troubleshooting docs, but since the Community is mentioned here, it might be an appropriate spot.

Anyway, let me know if this is ok.
@mbumpalumpa
Copy link
Contributor

@luke- sorry idk how i missed it the first time, but here it is eb6b45c

@luke-
Copy link
Contributor

luke- commented Sep 4, 2024

@mbumpalumpa I would rather remove the paragraph completely from the “installation.md” file. (No longer necessary, as everything is fine by default).

And move the paragraph to "troubleshooting.md". How to activate the debug mode. It also makes sense to show there how to access the log entries via (Administration -> Information -> Logging).

@luke- hopefully, this is what you meant. I added logging as part of the "Debug Mode", but did you want it as a separate section instead?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants