Skip to content

Commit 04fe694

Browse files
authored
Merge pull request #1357 from mathbunnyru/asalikhov/rearrange_readme
Put quick start first in README.md
2 parents 9a79c72 + 7f063ae commit 04fe694

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,6 @@
1010
Jupyter Docker Stacks are a set of ready-to-run [Docker images](https://hub.docker.com/u/jupyter)
1111
containing Jupyter applications and interactive computing tools.
1212

13-
## Maintainer Help Wanted
14-
15-
We value all positive contributions to the Docker stacks project, from
16-
[bug reports](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/issues.html) to
17-
[pull requests](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/packages.html)
18-
to
19-
[translations](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/translations.html)
20-
to help answering questions. We'd also like to invite members of the community to help with two
21-
maintainer activities:
22-
23-
- Issue triage: Reading and providing a first response to issues, labeling issues appropriately,
24-
redirecting cross-project questions to Jupyter Discourse
25-
- Pull request reviews: Reading proposed documentation and code changes, working with the submitter
26-
to improve the contribution, deciding if the contribution should take another form (e.g., a recipe
27-
instead of a permanent change to the images)
28-
29-
Anyone in the community can jump in and help with these activities at any time. We will happily
30-
grant additional permissions (e.g., ability to merge PRs) to anyone who shows an on-going interest
31-
in working on the project.
32-
33-
## Jupyter Notebook Deprecation Notice
34-
35-
Following [Jupyter Notebook notice](https://github.com/jupyter/notebook#notice), we encourage users to transition to JupyterLab.
36-
This can be done by passing the environment variable `JUPYTER_ENABLE_LAB=yes` at container startup,
37-
more information is available in the [documentation](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/common.html#docker-options).
38-
39-
At some point, JupyterLab will become the default for all of the Jupyter Docker stack images, however a new environment variable will be introduced to switch back to Jupyter Notebook if needed.
40-
41-
After the change of default, and according to the Jupyter Notebook project status and its compatibility with JupyterLab, these Docker images may remove the classic Jupyter Notebook interface altogether in favor of another _classic-like_ UI built atop JupyterLab.
42-
43-
This change is tracked in the issue [#1217](https://github.com/jupyter/docker-stacks/issues/1217), please check its content for more information.
44-
4513
## Quick Start
4614

4715
You can try a
@@ -89,6 +57,38 @@ Please see the [Contributor Guide on ReadTheDocs](https://jupyter-docker-stacks.
8957
information about how to contribute package updates, recipes, features, tests, and community
9058
maintained stacks.
9159

60+
## Maintainer Help Wanted
61+
62+
We value all positive contributions to the Docker stacks project, from
63+
[bug reports](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/issues.html) to
64+
[pull requests](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/packages.html)
65+
to
66+
[translations](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/translations.html)
67+
to help answering questions. We'd also like to invite members of the community to help with two
68+
maintainer activities:
69+
70+
- Issue triage: Reading and providing a first response to issues, labeling issues appropriately,
71+
redirecting cross-project questions to Jupyter Discourse
72+
- Pull request reviews: Reading proposed documentation and code changes, working with the submitter
73+
to improve the contribution, deciding if the contribution should take another form (e.g., a recipe
74+
instead of a permanent change to the images)
75+
76+
Anyone in the community can jump in and help with these activities at any time. We will happily
77+
grant additional permissions (e.g., ability to merge PRs) to anyone who shows an on-going interest
78+
in working on the project.
79+
80+
## Jupyter Notebook Deprecation Notice
81+
82+
Following [Jupyter Notebook notice](https://github.com/jupyter/notebook#notice), we encourage users to transition to JupyterLab.
83+
This can be done by passing the environment variable `JUPYTER_ENABLE_LAB=yes` at container startup,
84+
more information is available in the [documentation](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/common.html#docker-options).
85+
86+
At some point, JupyterLab will become the default for all of the Jupyter Docker stack images, however a new environment variable will be introduced to switch back to Jupyter Notebook if needed.
87+
88+
After the change of default, and according to the Jupyter Notebook project status and its compatibility with JupyterLab, these Docker images may remove the classic Jupyter Notebook interface altogether in favor of another _classic-like_ UI built atop JupyterLab.
89+
90+
This change is tracked in the issue [#1217](https://github.com/jupyter/docker-stacks/issues/1217), please check its content for more information.
91+
9292
## Alternatives
9393

9494
- [jupyter/repo2docker](https://github.com/jupyter/repo2docker) - Turn git repositories into

0 commit comments

Comments
 (0)