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 guide for healthchecks #1738

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

MetroMarv
Copy link
Contributor

Fixes #1724

v3.2
v3.1
[isabell@stardust ~]$ git checkout v3.2
Note: switching to 'v3.2'.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want me to keep all the log output from that command? Or should I somehow abbreviate it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case it might be nice to keep the whole output, someone who has never done this gets an idea of what is happening. I let that up to you though, abbreviating it would be fine too.

[isabell@stardust ~]$ python3.11 -m venv venv
[isabell@stardust ~]$ source venv/bin/activate
(venv) [isabell@stardust ~]$ pip3.11 install -r requirements.txt
Collecting aiosmtpd==1.4.4.post2 (from -r requirements.txt (line 1))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want me to keep all the log output from that command? Or should I somehow abbreviate it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's pretty long, please abbreviate it like in the Kimai Guide.


::

(venv) [isabell@stardust ~]$ python3.11 ./manage.py migrate
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here (and also in some of the following listings) I assume that the user is still in the active virtualenv. Do you want me to repeat the source venv/bin/activate command before each of the commands requiring the virtualenv?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question. If this was my guide I would provide a note before the first use of the venv with something like that:

.. note:: All following commands require the virtualenv, you can activate it with ``source venv/bin/activate`` in a new SSH-session

::

(venv) [isabell@stardust ~]$ python3.11 ./manage.py migrate
System check identified some issues:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again long log output that could be abbreviated.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it makes sense to abbreviate, there is no upside in keeping all of it.

@nichtmax nichtmax self-assigned this Apr 24, 2024
Copy link
Member

@nichtmax nichtmax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the guide! I left you some comments.

@nichtmax nichtmax marked this pull request as draft April 24, 2024 10:34
@nichtmax nichtmax removed their assignment Apr 24, 2024
@MetroMarv
Copy link
Contributor Author

Thanks for the responses. I'll take care of them at the end of the week!

@nichtmax
Copy link
Member

Any news here? If there's no feedback we'll close the PR.

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.

[healthcheck] Add Guide for healthchecks
3 participants