Skip to content

Commit b170630

Browse files
committedMar 2, 2022
Iterate on the README
1 parent 18bb945 commit b170630

File tree

5 files changed

+73
-32
lines changed

5 files changed

+73
-32
lines changed
 

‎README.md

+31-17
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Jupyter Notebook
22

3-
[![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter)
4-
[![Build Status](https://travis-ci.org/jupyter/notebook.svg?branch=master)](https://travis-ci.org/jupyter/notebook)
3+
![Github Actions Status](https://github.com/jupyter/notebook/workflows/Build/badge.svg)
54
[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest)
5+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/notebook/main?urlpath=tree)
66
[![codecov](https://codecov.io/gh/jupyter/notebook/branch/master/graph/badge.svg)](https://codecov.io/gh/jupyter/notebook)
77

88
The Jupyter notebook is a web-based notebook environment for interactive
@@ -12,19 +12,23 @@ computing.
1212

1313
### Notice
1414

15-
Please note that this repository is currently maintained by a skeleton crew of maintainers from the Jupyter community. We encourage users to transition to JupyterLab, where more immediate support can occur. Our approach moving forward will be:
15+
The Jupyter Notebook project is currently undertaking a transition to a more modern code base built from the ground-up using JupyterLab components and extensions.
1616

17-
1. To maintain the security of the Jupyter Notebook. That means security-related issues and pull requests are our highest priority.
18-
2. To address JupyterLab [feature parity issues](https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aopen+is%3Aissue+label%3A%22tag%3AFeature+Parity%22). As part of this effort, we are also working on a better [notebook-only experience](https://github.com/jupyterlab/jupyterlab/issues/8450) in JupyterLab for users who prefer the UI of the classic Jupyter Notebook.
19-
3. To be responsive to the hard work of community members who have opened pull requests. We are triaging these PRs. We cannot support or maintain new features at this time, but we welcome security and other sustainability fixes.
17+
There is new stream of work which was submitted and then accepted as a Jupyter Enhancement Proposal (JEP): https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html
2018

21-
If you have an open pull request with a new feature or if you were planning to open one, please consider shipping it as a [notebook extension](https://jupyter-notebook.readthedocs.io/en/stable/extending/) instead.
19+
#### Notebook v7
2220

23-
##### Alternatives to contributing to `notebook`
21+
TODO
2422

25-
Additionally, please consider whether your contribution would be appropriate for either the underlying server for Jupyter front-ends, [jupyter_server](https://github.com/jupyter/jupyter_server) or in the [JupyterLab front-end](https://github.com/jupyterlab/jupyterlab).
23+
#### Classic Notebook v6
2624

27-
### Jupyter notebook, the language-agnostic evolution of IPython notebook
25+
Maintainance and security-related issues are now being addressed in the [`6.4.x`](https://github.com/jupyter/notebook/tree/6.4.x) branch.
26+
27+
New features and continuous improvement is now focused on Notebook v7 (see section above).
28+
29+
If you have an open pull request with a new feature or if you were planning to open one, we encourage switching over to the Jupyter Server and JupyterLab architecture, and distribute it as a server extension and / or JupyterLab prebuilt extension. That way your new feature will also be compatible with the new Notebook v7.
30+
31+
### Jupyter notebook, the language-agnostic evolution of IPython notebo
2832

2933
Jupyter notebook is a language-agnostic HTML notebook application for
3034
Project Jupyter. In 2015, Jupyter notebook was released as a part of
@@ -35,8 +39,9 @@ computing spans across many languages, Project Jupyter will continue to develop
3539
language-agnostic **Jupyter notebook** in this repo and with the help of the
3640
community develop language specific kernels which are found in their own
3741
discrete repos.
38-
[[The Big Split™ announcement](https://blog.jupyter.org/the-big-split-9d7b88a031a7)]
39-
[[Jupyter Ascending blog post](https://blog.jupyter.org/jupyter-ascending-1bf5b362d97e)]
42+
43+
- [The Big Split™ announcement](https://blog.jupyter.org/the-big-split-9d7b88a031a7)
44+
- [Jupyter Ascending blog post](https://blog.jupyter.org/jupyter-ascending-1bf5b362d97e)
4045

4146
## Installation
4247

@@ -48,27 +53,36 @@ The documentation for advanced usage of Jupyter notebook can be found
4853
For a local installation, make sure you have
4954
[pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
5055

51-
$ pip install notebook
56+
```bash
57+
pip install notebook
58+
```
5259

5360
## Usage - Running Jupyter notebook
5461

5562
### Running in a local installation
5663

5764
Launch with:
5865

59-
$ jupyter notebook
66+
```bash
67+
jupyter notebook
68+
```
6069

6170
### Running in a remote installation
6271

6372
You need some configuration before starting Jupyter notebook remotely. See [Running a notebook server](https://jupyter-notebook.readthedocs.io/en/stable/public_server.html).
6473

6574
## Development Installation
6675

67-
See [`CONTRIBUTING.rst`](CONTRIBUTING.rst) for how to set up a local development installation.
76+
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for how to set up a local development installation.
6877

6978
## Contributing
7079

71-
If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](CONTRIBUTING.rst).
80+
If you are interested in contributing to the project, see [`CONTRIBUTING.md`](CONTRIBUTING.md).
81+
82+
## Community Guidelines and Code of Conduct
83+
84+
This repository is a Jupyter project and follows the Jupyter
85+
[Community Guides and Code of Conduct](https://jupyter.readthedocs.io/en/latest/community/content-community.html).
7286

7387
## Resources
7488

@@ -78,4 +92,4 @@ If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](C
7892
- [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/)
7993
- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]
8094
- [Issues](https://github.com/jupyter/notebook/issues)
81-
- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter)
95+
- [Technical support - Jupyter Google Group](https://discourse.jupyter.org/)

‎docs/resources/notebook_basics.png

-566 KB
Binary file not shown.

‎docs/resources/running_code.png

-614 KB
Binary file not shown.

‎docs/resources/running_code_med.png

609 KB
Loading

‎docs/source/examples/Notebook/Running Code.ipynb

+42-15
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,12 @@
3030
},
3131
{
3232
"cell_type": "code",
33-
"execution_count": 2,
33+
"execution_count": 1,
3434
"metadata": {
35-
"collapsed": false
35+
"collapsed": false,
36+
"jupyter": {
37+
"outputs_hidden": false
38+
}
3639
},
3740
"outputs": [],
3841
"source": [
@@ -41,9 +44,12 @@
4144
},
4245
{
4346
"cell_type": "code",
44-
"execution_count": 3,
47+
"execution_count": 2,
4548
"metadata": {
46-
"collapsed": false
49+
"collapsed": false,
50+
"jupyter": {
51+
"outputs_hidden": false
52+
}
4753
},
4854
"outputs": [
4955
{
@@ -84,9 +90,12 @@
8490
},
8591
{
8692
"cell_type": "code",
87-
"execution_count": 4,
93+
"execution_count": 3,
8894
"metadata": {
89-
"collapsed": false
95+
"collapsed": false,
96+
"jupyter": {
97+
"outputs_hidden": false
98+
}
9099
},
91100
"outputs": [],
92101
"source": [
@@ -106,7 +115,10 @@
106115
"cell_type": "code",
107116
"execution_count": 5,
108117
"metadata": {
109-
"collapsed": false
118+
"collapsed": false,
119+
"jupyter": {
120+
"outputs_hidden": false
121+
}
110122
},
111123
"outputs": [],
112124
"source": [
@@ -174,7 +186,10 @@
174186
"cell_type": "code",
175187
"execution_count": 6,
176188
"metadata": {
177-
"collapsed": false
189+
"collapsed": false,
190+
"jupyter": {
191+
"outputs_hidden": false
192+
}
178193
},
179194
"outputs": [
180195
{
@@ -193,7 +208,10 @@
193208
"cell_type": "code",
194209
"execution_count": 7,
195210
"metadata": {
196-
"collapsed": false
211+
"collapsed": false,
212+
"jupyter": {
213+
"outputs_hidden": false
214+
}
197215
},
198216
"outputs": [
199217
{
@@ -227,7 +245,10 @@
227245
"cell_type": "code",
228246
"execution_count": 8,
229247
"metadata": {
230-
"collapsed": false
248+
"collapsed": false,
249+
"jupyter": {
250+
"outputs_hidden": false
251+
}
231252
},
232253
"outputs": [
233254
{
@@ -270,7 +291,10 @@
270291
"cell_type": "code",
271292
"execution_count": 9,
272293
"metadata": {
273-
"collapsed": false
294+
"collapsed": false,
295+
"jupyter": {
296+
"outputs_hidden": false
297+
}
274298
},
275299
"outputs": [
276300
{
@@ -346,7 +370,10 @@
346370
"cell_type": "code",
347371
"execution_count": 10,
348372
"metadata": {
349-
"collapsed": false
373+
"collapsed": false,
374+
"jupyter": {
375+
"outputs_hidden": false
376+
}
350377
},
351378
"outputs": [
352379
{
@@ -864,7 +891,7 @@
864891
],
865892
"metadata": {
866893
"kernelspec": {
867-
"display_name": "Python 3",
894+
"display_name": "Python 3 (ipykernel)",
868895
"language": "python",
869896
"name": "python3"
870897
},
@@ -878,9 +905,9 @@
878905
"name": "python",
879906
"nbconvert_exporter": "python",
880907
"pygments_lexer": "ipython3",
881-
"version": "3.5.1"
908+
"version": "3.10.2"
882909
}
883910
},
884911
"nbformat": 4,
885-
"nbformat_minor": 0
912+
"nbformat_minor": 4
886913
}

0 commit comments

Comments
 (0)
Please sign in to comment.