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

Improve Email follow-ups configuration and fix missing logo #125

Merged
merged 3 commits into from May 14, 2024

Conversation

gonzaleztroyano
Copy link
Contributor

  • Fix some lists, the missing linebreak was causing Sphinx treating it as a paragraph.
  • Use a table to improve readability for global configuration options.
  • Add additional info about IMAP OAth (internal link)
  • Add missing GLPI logo. It's now shown on top of sidebar.
  • Minor fixes

Build preview:
image

 - Fix some lists, the missing linebreak was causing Sphinx treating it as a paragraph.
  - Use a table to improve readability for global configuration options.
  - Add additional info about IMAP OAth (internal link)
  - Add missing GLPI logo. It's now shown on top of sidebar.
  - Minor fixes
@cconard96
Copy link
Collaborator

Looks good to me, except maybe the logo (blue logo on blue background). The white version of this logo may look better here (pics/logos/logo-GLPI-25-white.png in the GLPI files).

@gonzaleztroyano
Copy link
Contributor Author

Hi, @cconard96! Thanks for your feedback. I've updated the image.

- Max delivery retries - Number times GLPI will try to send a notification.
- Try to deliver again in (minutes) - Time between notification delivery attempts.

+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure table is the better option for display; it currently adds an horizontal scroll :/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmmm...

I'm working on it. There's something called Line blocs that I think can be useful to solve both problems:

  • Horizontal scrolling (adding more line breaks)
  • The need to declare the br snippet. That can be useful, but I think it's better to avoid it.

Line blocks even works on tables (I was not sure about this). The code:

+------------------------------------------------------+------------------------------------------------------------------------------------------------+
|                           **Option**                 |                                  **Meaning**                                                   |
+------------------------------------------------------+------------------------------------------------------------------------------------------------+
| `Administrator email`                                | | GLPI Administrator email.                                                                    |
|                                                      | | This can be used as a special recipient in notifications                                     |
+------------------------------------------------------+------------------------------------------------------------------------------------------------+

Generates:
image

I'm working on a CSS custom rule to avoid the added below line space. Editing the following rule (only for the table(s), of course) looks to solve the problem:
image

Waiting for feedback on how to continue. Thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

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

[...]
Line blocks even works on tables (I was not sure about this). The code:

Sounds good to me :) I also agree it would be better not to declare br at all.

I'm working on a CSS custom rule to avoid the added below line space. Editing the following rule (only for the table(s), of course) looks to solve the problem:
[...]

👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated. Waiting for your review :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

This is way better, thank you :)

@trasher trasher requested a review from orthagh May 13, 2024 06:20
This commit updates the email_notifications.rst file to, instead of the previously declared and used |br| html snippet, use the Sphinx 'Line block' feature.

Adding the correct line breaks on the line blocks prevent the horizontal scrolling on the table.

Because of this use, a margin was added below the last line. A custom CSS rule is added to prevent this behavior.

To add the custom CSS, the conf.py has been updated.

Minor grammatical fixes on other files.
@trasher trasher merged commit 17cc997 into glpi-project:master May 14, 2024
1 check passed
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.

None yet

3 participants