jupyterhub / the-littlest-jupyterhub

Simple JupyterHub distribution for 1-100 users on a single server
https://tljh.jupyter.org
BSD 3-Clause "New" or "Revised" License
1.04k stars 341 forks source link

cut and paste problem in TLJH release 0.1 guide #377

Closed burkett123 closed 3 years ago

burkett123 commented 5 years ago

The following cut and paste section contains extra characters in several of the places it's used. Before "master/boot" if your viewer hides the details.

#!/bin/bash
curl https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/
˓→master/bootstrap/bootstrap.py \
| sudo python3 - \
--admin <admin-user-name>
GeorgianaElena commented 5 years ago

Hi @burkett123! Are you referring to the red arrow in the picture bellow (from the pdf documentation)? arrow_doc

This arrow it's sphinx's way of wrapping long code lines and it should not be treated as part of the syntax, it's only an indicator that what's after the arrow belongs to the same line. I agree that when you copy and paste the command from the pdf, you get some extra chars with the arrow. You might want to also check the TLJH html documentation which allows you to easily copy and paste a command.

burkett123 commented 5 years ago

Yes, you are correct.  It's the extra characters when used to cut and paste that cause the problem.  If this is an artifact of the sphinx, then maybe shorter lines with additional \ would be the solution.

  Just a thought and observation.

Thanks.

On 6/25/19 7:54 AM, Georgiana Elena wrote:

Hi @burkett123 https://github.com/burkett123! Are you referring to the red arrow in the picture bellow (from the pdf documentation)? arrow_doc https://user-images.githubusercontent.com/7579677/60099009-7315b300-975f-11e9-95d1-6853f8f5f065.png

This arrow it's sphinx' http://www.sphinx-doc.org/en/master/s way of wrapping long code lines and it should not be treated as part of the syntax, it's only an indicator that what's after the arrow belongs to the same line. I agree that when you copy and paste the command from the pdf, you get some extra chars with the arrow. You might want to also check the TLJH html documentation https://the-littlest-jupyterhub.readthedocs.io/en/latest/topic/customizing-installer.html which allows you to easily copy and paste a command.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/jupyterhub/the-littlest-jupyterhub/issues/377?email_source=notifications&email_token=ACOCXQL526XADEG2VWHKDN3P4IIQTA5CNFSM4HYWJECKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODYQELEI#issuecomment-505431441, or mute the thread https://github.com/notifications/unsubscribe-auth/ACOCXQLT2N3AQK6PR2QSQYDP4IIQTANCNFSM4HYWJECA.

GeorgianaElena commented 5 years ago

Thanks a lot for the suggestion @burkett123, very much appreciated. What are your thoughts on splitting the url @yuvipanda :) ?

consideRatio commented 3 years ago

The URL is now shorter: https://tljh.jupyter.org/bootstrap.py, closing.