jupyterhub
jupyterhub copied to clipboard
Documentation issue: c.JupyterHub.port is deprecated but not indicated in doc
Bug description
In the docs in url: https://jupyterhub.readthedocs.io/en/stable/getting-started/networking-basics.html it states that:
Or by placing the following lines in a configuration file, jupyterhub_config.py:
c.JupyterHub.ip = '192.168.1.2'
c.JupyterHub.port = 443
But in the latest Jupyterhub 2.x.x the generated config file states the above property is deprecated:
## The public facing port of the proxy.
#
# This is the port on which the proxy will listen.
# This is the only port through which JupyterHub
# should be accessed by users.
#
# .. deprecated: 0.9
# Use JupyterHub.bind_url
# Default: 8000
# c.JupyterHub.port = 8000
Expected behaviour
The readthedocs document should mention the non-deprecated property not the deprecated property.
Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.
You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! :wave:
Welcome to the Jupyter community! :tada:
Thanks for catching and reporting this @ebebpl! The docs should be indeed updated with latest info.
A PR to fix this issue would be very appreciated and a great first JupyterHub contribution ✨ The source of that docs page is this file https://github.com/jupyterhub/jupyterhub/blob/main/docs/source/getting-started/networking-basics.md
Hi, I would like to work on this issue.
Thanks @hsadia538 you can work on it.
I have submitted a PR that closes this issue #4042. Please review and accept.
Hey @ebebpl, if no one is working on this issue at the moment, could I give it a try?😊
@BhavyaT-135 you can go ahead if no pending fix or PRs.
Hi @ebebpl, I have created a pull request addressing the mentioned issue. Kindly take a look and suggest any changes if required. 😊
Hey, @ebebpl I would like to work on this issue, can you please help me to understand this issue and assign it to me?
@akashthedeveloper this issue already fixed by another user so no longer need further work.
Thanks, @ebebpl for clarifying but can you please close this issue if it is solved?
@akashthedeveloper The pull requests are open, it will be closed when they have been reviewed and merged. You can see the links on the right hand side:
and linked in the conversation:
hi @ebebpl i would like to work on this issue
@Achele please read earlier comments this is already done by others.
my bad, @ebebpl thanks for the clarification.