Commit Graph

48 Commits

Author SHA1 Message Date
Lili Yao
ad25ef8f87 Update roadmap.md
It seems that we don't need an "a" here, or should we change it to "an" instead?
2022-10-23 15:42:57 +11:00
Georgiana
30e652f59e Merge pull request #4081 from Christiandike/Update/docs
Migrate community channels to markdown, update text
2022-10-19 11:59:43 +02:00
pre-commit-ci[bot]
d407c96ee8 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-10-19 09:47:27 +00:00
Christian Dike
84e1216dda Update docs/source/contributing/community.md
Co-authored-by: Georgiana <georgiana.dolocan@gmail.com>
2022-10-19 10:45:49 +01:00
Christian Dike
c8aae0ea1c Update docs/source/contributing/community.md
Co-authored-by: Georgiana <georgiana.dolocan@gmail.com>
2022-10-19 10:44:41 +01:00
Christian Dike
313623256f Update docs/source/contributing/community.md
Co-authored-by: Georgiana <georgiana.dolocan@gmail.com>
2022-10-19 10:44:15 +01:00
Georgiana
da7ac11605 Merge pull request #4069 from chicken-biryani/main
Update the testing docs
2022-10-19 11:29:36 +02:00
Shloka
15b8857728 Update docs/source/contributing/tests.rst
Co-authored-by: Min RK <benjaminrk@gmail.com>
2022-10-17 22:30:55 +05:30
Shloka
79ea4038e5 Update docs/source/contributing/tests.rst
Co-authored-by: Min RK <benjaminrk@gmail.com>
2022-10-17 22:30:47 +05:30
pre-commit-ci[bot]
838719e7ab [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-10-17 15:11:38 +01:00
Christian Dike
6ca5c1a276 Update documentation
Fix structure of documentation to aid readability and flow.
2022-10-17 15:09:40 +01:00
Min RK
93529d11bc Merge pull request #4065 from chicken-biryani/community-channels
Modification in community channels docs
2022-10-17 13:01:00 +02:00
Shloka
5018c13b81 Fixes 2022-10-12 19:31:04 +05:30
Shloka
b0f90a0f4b Update docs/source/contributing/tests.rst
Co-authored-by: Simon Li <orpheus+devel@gmail.com>
2022-10-12 19:08:01 +05:30
Shloka
7a915533a6 Update docs/source/contributing/tests.rst
Co-authored-by: Simon Li <orpheus+devel@gmail.com>
2022-10-12 19:07:50 +05:30
Shloka
733e018bdc Update docs/source/contributing/tests.rst
Co-authored-by: Simon Li <orpheus+devel@gmail.com>
2022-10-12 19:07:43 +05:30
pre-commit-ci[bot]
a87872e7aa [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-10-12 13:28:00 +00:00
Shloka
578c78397a Modifications 2022-10-12 18:56:30 +05:30
Shloka
0820f4cfa1 Modifications 2022-10-12 18:52:58 +05:30
Goodness Chris-Ugari
45b5a249c6 Update setup.rst
Corrected JupyterHub capitalization
2022-10-11 13:02:10 +01:00
Shloka
395b1a5681 Modifications is testing docs 2022-10-09 19:07:20 +05:30
Goodness Chris-Ugari
65caf37d71 Update setup.rst
This PR improves the setup page and is part of issue #41
2022-10-09 12:37:52 +01:00
pre-commit-ci[bot]
204bfaf8f4 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-10-08 17:13:41 +00:00
Shloka
f0c825cc1e Modification in community channels 2022-10-08 22:40:22 +05:30
Temidayo
15bf61df2a modified the contributing documentation 2022-10-02 14:39:51 +01:00
Simon Li
85a4bbc28e Update Contributing documentation
Adds yarn, moves most of CONTRIBUTING.md into https://jupyterhub.readthedocs.io/en/stable/contributing/index.html to reduce duplication
2022-05-29 19:11:57 +01:00
Min RK
63a61bcc2f prepare to rename default branch to main
- update references to default branch name in docs, workflows
- use HEAD in github urls, which always works regardless of default branch name
- fix petstore URLs since the old petstore links seem to have stopped working
2021-05-11 10:40:04 +02:00
Min RK
9331dd13da run pre-commit (prettier) 2021-02-12 15:25:58 +01:00
Leo Gallucci
10f09f4f70 Remove already done named servers from roadmap
Remove already done "UI for managing named servers" from the roadmap
2020-06-12 18:00:00 +02:00
Matt Riedemann
c50e1f9852 Update contributor doc wording around sqlite
sqlite3 should be available from the python standard library
so there shouldn't be a need to install native packages.
2020-03-09 15:11:45 -04:00
Matt Riedemann
6954e03bb4 Update contributor docs
As a new contributor to jupyterhub it took awhile to get
up and running locally mainly because I didn't have sqlite
installed but also because I was flipping between README,
CONTRIBUTING and the actual contributing docs which are all
a little bit different.

This does a few things:

- Updates the contributor sphinx docs to mention that how
  one chooses to isolate their development environment is
  up to them with a link to the detailed forum thread on
  that topic.
- Updates the contributor sphinx docs to mention sqlite and
  database setup in general. While in here some trailing
  whitespaces are cleaned up.
- Leave a comment in CONTRIBUTING.md about the redundant
  information in the docs on getting a development environment
  setup. Long-term we should really get those merged so there
  is a single authoritative document on how to get a dev env
  setup for contributing to jupyterhub.
- Link to the jupyterhub gitter channel for asking questions.
2020-03-04 13:09:48 -05:00
Bruno P. Kinoshita
3b05135f11 Fix couple typos 2020-02-24 20:48:42 +13:00
Min RK
33e1a090d8 Merge pull request #2812 from jgwerner/update-tests-docs
docs: Update docs to run tests
2019-12-03 13:19:26 +01:00
Chris Holdgraf
45a4362bb3 fixing EOL 2019-11-21 08:04:20 -08:00
Chris Holdgraf
676a0da5ff fixing links 2019-11-21 08:04:20 -08:00
Chris Holdgraf
c8e4d68978 updating to pandas docs theme 2019-11-21 08:04:20 -08:00
Greg
948f4c44fd update docs
Signed-off-by: Greg <werner.greg@gmail.com>
2019-11-08 13:00:44 -05:00
Dan Lester
49a5f3a654 Fixed docs and testing code to use refactored SimpleLocalProcessSpawner 2019-07-05 10:53:47 +01:00
Tim Head
4258254c39 Merge pull request #2509 from minrk/sec-doc
Add security-reporting to docs
2019-04-05 17:33:44 +02:00
Min RK
ee0020e8fa add security-reporting to docs 2019-04-05 11:51:02 +02:00
Min RK
2d83575a24 add discourse link to communication docs 2019-04-05 11:46:44 +02:00
Min RK
5e60582ef3 run autoformat
apologies to anyone finding this commit via git blame or log

run the autoformatting by

    pre-commit run --all-files
2019-02-19 17:00:10 +01:00
Chris Holdgraf
891a352f42 updating circle for docs and adding a roadmap 2018-11-14 21:20:26 -08:00
Chris Holdgraf
372af86250 rst code syntax in docs 2018-09-29 09:09:31 -07:00
Chris Holdgraf
c48988afcb pip command update 2018-09-28 12:00:28 -07:00
Kyla Harper
a78655c5a7 Add DummyAuthenticator documentation 2018-09-27 11:42:06 -05:00
yuvipanda
7c273296c2 Use python3 -m pip explicitly in docs
- Add a documentation convention listing this too.

Fixes #2191
2018-09-26 12:14:43 -07:00
yuvipanda
c928d10316 Expand contributor documentation
- Move from CONTRIBUTING.md to a subdirectory in docs, so
  we can expand and add more documentation.
- Move from markdown to reStructuredTest
- Add a direct blurb in the JupyterHub docs index page on
  how contribution.
- More prominent link to the Code of Conduct
- Add section on getting in touch with the JupyterHub community
2018-09-25 18:19:09 -07:00