Gramex installation bugs, improvements

[bkamapantula]

trafficstars

Conda installation on Linux

• In the conda installation step, Anaconda3-2020.02 is linked to the archives -- this is correct
• [x] Windows-x86, MacOSX-x86_64, Linux-x86_64, Linux-ppc64le have older version links.

We could drop the links to individual OS-related versions and just retain the file names.

• [x] add instruction on how to uninstall gramex via conda

[samarthgulati]

Searching "install gramex" / "gramex install" on both bing and google doesn't show learn.gramener.gramex/guide link as

• the first result on bing,
• and missing entirely on google, instead points to a gramener page.

[samarthgulati]

Gramex install page has a navigation bullet list before the instructions begin, which is confusing. Can omit the bullet list, as it is part of left navigation already and start with 'There are 4 ways..'

[jaidevd]

Improve docker documentation:

After installing docker and pulling the Gramex image, the guide asks users to restart the container by running

docker start -ia gramex

And in the very next steps, mentions that folders can be shared with the -v flag. This makes it seem like the -v flag applies to the docker start command, whereas it actually applies to the docker run command. The docs need to clarify this.

[jaidevd]

The docs need one explicit docker command that shows how to:

1. share folders
2. forward ports
3. and run Gramex

through a single call.

[samarthgulati]

learn.gramener.com/guide layout breaks with IE, need to show pop-up if IE detected, mentioning IE not supported for guide and suggesting to install edge/chrome/firefox

[jaidevd]

This command should be visible in the guide:

docker run -it -p 9988:9988  -v /path/on/host:/path/on/container gramener/gramex:latest /bin/bash 

with the following comments:

1. -p option forwards a port from the container to a port on the host.
2. -v shares a folder on the host to the container

[bkamapantula]

Search results (top navigation bar) in Gramex Guide

• [x] Hide search results if the user clicks anywhere else. Currently it hides the documentation view.

[samarthgulati]

Conda install on windows instructions end with conda update -c conda-forge -c gramener gramex which is confusing, as we just isntalled gramex maybe would be better to say installation is complete, and direct them to gramex init

[samarthgulati]

Conda install suggests running commands in Anaconda Prompt / shell To install gramex, type this in your Anaconda Prompt / shell: My version of windows didn't have either, I ran it in command prompt and it worked fine, not sure if it is obvious.

[samarthgulati]

https://learn.gramener.com/guide/mlhandler/#creating-new-models the given yaml configuration assumes it has to be pasted under url. might be good to add url: e.g.:

url:
  modelhandler/tutorial:
  ....

[jaidevd]

pip install issues:

1. Ideally this should be independent of whether users have Anaconda. The first step in the guide mentions Anaconda. It should not. When doing a pip install, users should be asked to ensure only two things - that Python 3.7 exists, and pip exists.
2. Installing the "nodejs" package on Linux doesn't necessarily install npm. The guide should mention that it is npm that is ultimately required.
3. The -g option in npm install -g yarn doesn't work on all versions on npm. Is it necessary? If not, exclude it from the docs.
4. Overall, the installation of nodejs / npm / yarn is not clear, and may be very platform-specific.

[bkamapantula]

we can install node, npm via nvm: https://linuxize.com/post/how-to-install-node-js-on-ubuntu-20-04/#installing-nodejs-and-npm-using-nvm

this enables multiple node installations and switching between them.

[samarthgulati]

Capture handler guide has deprecated documentation for v1.23 https://learn.gramener.com/guide/capturehandler/#chrome

[jaidevd]

On a headless Linux, Capturehandler needs the following system libs, all installable via the respective package manager:

1. libnss3
2. libcups2
3. libxss1
4. libatk1.0-0
5. libatk-bridge2.0-0
6. libpangocairo-1.0-0
7. libgtk-3-0

[bhatsandeep]

Offline install for Windows - Instructions are not available

[samarthgulati]

gramex guide setup.sh conda install should include rpy2

conda install -y -q -c r r-ggplot2 r-rmarkdown rpy2

[bkamapantula]

we support node versions between 7.6 and 14 -- pkg/conda/template.meta.yml

• [x] however, pip installation method suggests node 10 or later. can we please make it consistent here?

[bkamapantula]

gramex installation via conda restricts to Python 3.7 version

• [x] we need a similar restriction via pip installation in setup.py. we could use python_requires attribute as supported officially

setup(
  ...
  python_requires ="<3.8",
  ...
)

this will ensure pip install gramex fails for Python 3.8 with the below error:

ERROR: Package 'gramex' requires a different Python: 3.8.8 not in '<3.8'

[jaidevd]

On a machine which doesn't have bash, running an app with a setup.sh (like Guide) in it fails. Gramex silently ignores setup.sh, and moves over to other files like package.json, etc. It should warn the user that it has found a setup.sh, but since it can't find bash, it's ignoring setup.sh

[samarthgulati]

python installer linked in guide expects admin privilege unchecking "install for all users" didn't work

[samarthgulati]

running guide R page's see plot link for first time after installing rpy2 on windows throws this error and the app crashes runs fine from second time onwards

INFO    01-Mar 08:12:01 __init__ 9988 200 GET /r/plot_async.png (::1) 9308.29ms subdirs:C:/Users/noadmin/Downloads/gramex-guide-master/gramex-guide-master/r/gramex.yaml:r/plot_async.png
Error: C stack usage  71127200 is too close to the limit
Error: C stack usage  71126528 is too close to the limit