Skip to content

Feature Request: Added documentation for installation of graphicsmagick #455

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

Ashu463
Copy link

@Ashu463 Ashu463 commented Apr 19, 2025

Added documentation for installation of graphicsmagick, which is discussed in this oppia/oppia#21694 PR several times.

In this PR I added installation steps for linux and mac users only. I'll add installation steps for windows soon.

Thanks.

@Ashu463
Copy link
Author

Ashu463 commented Apr 19, 2025

@U8NWXD could you PTAL here.

* [Notes on installation on Arch Linux systems](#notes-on-installation-on-arch-linux-systems)
* [Changes to installation prerequisites](#changes-to-installation-prerequisites)
* [Changes to the virtual environment setup](#changes-to-the-virtual-environment-setup)
- [Table of Contents](#table-of-contents)
Copy link
Member

Choose a reason for hiding this comment

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

We exclude the table of contents entry from the table of contents

Comment on lines +43 to +46
- For MacOS:
```
brew install graphicsmagick
```
Copy link
Member

Choose a reason for hiding this comment

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

The macOS installation instructions should go in our separate macOS installation guide

Comment on lines +37 to +42
3. Install GraphicsMagick to enable local image compression and ensure tests run successfully. Follow the appropriate steps below based on your operating system:
- For Ubuntu/Debian systems:
```
sudo apt-get update
sudo apt-get install graphicsmagick
```
Copy link
Member

Choose a reason for hiding this comment

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

why not just add graphicsmagick to the packages installed in step 1 and to scripts/install_prerequisites.sh? that seems simpler

Comment on lines +47 to +50
After installation, verify that GraphicsMagick is correctly installed by running:
```
gm version
```
Copy link
Member

Choose a reason for hiding this comment

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

I think you can skip this, as we don't confirm installation of any of our other prerequisites. Dropping this will also let you more easily fold this change into step 1

@U8NWXD U8NWXD assigned Ashu463 and unassigned U8NWXD May 19, 2025
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.

2 participants