Add suggested font packages in troubleshooting tips #189
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,13 +37,32 @@ OpenSearch Dashboards Reports integration with [Notifications](https://github.co | |
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Fail to launch Chromium | ||
|
|
||
| There could be two reasons for this problem | ||
|
|
||
| 1. You are not having the correct version of headless-chrome matching to the OS that your OpenSearch Dashboards is running. Different versions of headless-chrome can be found [here](https://github.com/opensearch-project/dashboards-reports/releases/tag/chromium-1.12.0.0) | ||
|
|
||
| 2. Missing additional dependencies. Please refer to [additional dependencies section](./dashboards-reports/rendering-engine/headless-chrome/README.md#additional-libaries) to install required dependencies according to your operating system. | ||
|
|
||
| ### System Dependencies | ||
| Chromium may not have all of the dependencies you may require to be able to view all of the content of your reports. | ||
|
|
||
| If you are using a CentOS/RHEL system, install the following packages: | ||
| * [`ipa-gothic-fonts`](https://centos.pkgs.org/8/raven-x86_64/ipa-gothic-fonts-003.03-15.el8.noarch.rpm.html) | ||
|
There was a problem hiding this comment. why is this package for centos 8 while others are for 7? i don't think there's many people using 8 as its EOL is in less than 2 months There was a problem hiding this comment. I took the packages that were suggested from the corresponding page on the Elastic docs, wasn't aware that centos 8 is being deprecated so soon. Looks like CentOS 7 EOL is not until 2024, can change it to that for now There was a problem hiding this comment. Looks like this package doesn't exist for 7, will need to find an alternate There was a problem hiding this comment. |
||
| * [`xorg-x11-fonts-100dpi`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-100dpi-7.5-9.el7.noarch.rpm.html) | ||
| * [`xorg-x11-fonts-75dpi`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-75dpi-7.5-9.el7.noarch.rpm.html) | ||
| * [`xorg-x11-utils`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-utils-7.5-23.el7.x86_64.rpm.html) | ||
| * [`xorg-x11-fonts-cyrillic`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-cyrillic-7.5-9.el7.noarch.rpm.html) | ||
| * [`xorg-x11-fonts-Type1`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-Type1-7.5-9.el7.noarch.rpm.html) | ||
| * [`xorg-x11-fonts-misc`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-misc-7.5-9.el7.noarch.rpm.html) | ||
| * [`fontconfig`](https://www.freedesktop.org/wiki/Software/fontconfig/) | ||
| * [`freetype`](https://freetype.org/) | ||
|
|
||
| If you are using a Ubuntu/Debian system, install the following packages: | ||
| * [`fonts-liberation`](https://packages.debian.org/search?keywords=fonts-liberation) | ||
| * [`libfontconfig1`](https://packages.debian.org/sid/libfontconfig1) | ||
|
There was a problem hiding this comment. maybe also provide the yum/apt install -y command like in https://github.com/opensearch-project/dashboards-reports/blob/main/dashboards-reports/rendering-engine/headless-chrome/README.md#additional-libaries? There was a problem hiding this comment. Added a link to that command since the packages listed are actually all the same. Also added ipa-gothic-fonts to that section and linked the centos 7 version instead (ended up finding it) |
||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [opensource-codeofconduct@amazon.com](mailto:opensource-codeofconduct@amazon.com) with any additional questions or comments. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this title is under
Troubleshootingsection, I think it's better for title to be clear about thetrouble, something likeFail to/couldn't .... Also we need to update the documentation on our Opensearch website. Do you know if there's any related tracking issue opened for that?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure we can have a more specific title. No related tracking issue for OpenSearch documentation but offline I am planning to open this issue with Infra team to have these types of dependencies auto-installed.