Merge pull request #1379 from mathbunnyru/asalikhov/docs_long_lines

Limit markdown line length to 200

Author: mathbunnyru

.github/ISSUE_TEMPLATE/feature_request.md

@@ -20,4 +20,7 @@ Example: Add a package [altair](https://altair-viz.github.io).
 
 **How does this change will affect users?**
 
-Example: Altair is a declarative statistical visualization library for Python, based on Vega and Vega-Lite, and the source is available on GitHub. With Altair, you can spend more time understanding your data and its meaning. Altair’s API is simple, friendly and consistent and built on top of the powerful Vega-Lite visualization grammar. This elegant simplicity produces beautiful and effective visualizations with a minimal amount of code.
+Example: Altair is a declarative statistical visualization library for Python, based on Vega and Vega-Lite, and the source is available on GitHub.
+With Altair, you can spend more time understanding your data and its meaning.
+Altair’s API is simple, friendly and consistent and built on top of the powerful Vega-Lite visualization grammar.
+This elegant simplicity produces beautiful and effective visualizations with a minimal amount of code.

.markdownlint.yaml

@@ -4,4 +4,4 @@ default: true
 # MD013/line-length - Line length
 MD013:
   # Number of characters
-  line_length: 1000
+  line_length: 200

README.md

@@ -12,44 +12,45 @@ containing Jupyter applications and interactive computing tools.
 
 ## Quick Start
 
-You can try a
-[relatively recent build of the jupyter/base-notebook image on mybinder.org](https://mybinder.org/v2/gh/jupyter/docker-stacks/master?filepath=README.ipynb)
-by simply clicking the preceding link. The image used in binder was last updated on 22 May 2021.
-Otherwise, the two examples below may help you get started if
-you [have Docker installed](https://docs.docker.com/install/) know
-[which Docker image](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html) you
-want to use, and want to launch a single Jupyter Notebook server in a container.
-
-The [User Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/) describes additional
-uses and features in detail.
-
-**Example 1:** This command pulls the `jupyter/scipy-notebook` image tagged `33add21fab64` from
-Docker Hub if it is not already present on the local host. It then starts a container running a
-Jupyter Notebook server and exposes the server on host port 8888. The server logs appear in the
-terminal. Visiting `http://<hostname>:8888/?token=<token>` in a browser loads the Jupyter Notebook
-dashboard page, where `hostname` is the name of the computer running docker and `token` is the
-secret token printed in the console. The container remains intact for restart after the notebook
-server exits.
-
-    docker run -p 8888:8888 jupyter/scipy-notebook:33add21fab64
-
-**Example 2:** This command performs the same operations as **Example 1**, but it exposes the server
-on host port 10000 instead of port 8888. Visiting `http://<hostname>:10000/?token=<token>` in a
-browser loads JupyterLab, where `hostname` is the name of the computer running docker and `token` is
-the secret token printed in the console.::
-
-    docker run -p 10000:8888 jupyter/scipy-notebook:33add21fab64
-
-**Example 3:** This command pulls the `jupyter/datascience-notebook` image tagged `33add21fab64`
-from Docker Hub if it is not already present on the local host. It then starts an _ephemeral_
-container running a Jupyter Notebook server and exposes the server on host port 10000. The command
-mounts the current working directory on the host as `/home/jovyan/work` in the container. The server
-logs appear in the terminal. Visiting `http://<hostname>:10000/?token=<token>` in a browser loads
-JupyterLab, where `hostname` is the name of the computer running docker and `token` is the secret
-token printed in the console. Docker destroys the container after notebook server exit, but any
-files written to `~/work` in the container remain intact on the host.
-
-    docker run --rm -p 10000:8888 -e JUPYTER_ENABLE_LAB=yes -v "${PWD}":/home/jovyan/work jupyter/datascience-notebook:33add21fab64
+You can try a [relatively recent build of the jupyter/base-notebook image on mybinder.org](https://mybinder.org/v2/gh/jupyter/docker-stacks/master?filepath=README.ipynb)
+by simply clicking the preceding link.
+The image used in binder was last updated on 22 May 2021.
+Otherwise, the two examples below may help you get started if you [have Docker installed](https://docs.docker.com/install/),
+know [which Docker image](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html) you want to use
+and want to launch a single Jupyter Notebook server in a container.
+
+The [User Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/) describes additional uses and features in detail.
+
+**Example 1:** This command pulls the `jupyter/scipy-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host.
+It then starts a container running a Jupyter Notebook server and exposes the server on host port 8888.
+The server logs appear in the terminal.
+Visiting `http://<hostname>:8888/?token=<token>` in a browser loads the Jupyter Notebook dashboard page,
+where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console.
+The container remains intact for restart after the notebook server exits.
+
+```bash
+docker run -p 8888:8888 jupyter/scipy-notebook:33add21fab64
+```
+
+**Example 2:** This command performs the same operations as **Example 1**, but it exposes the server on host port 10000 instead of port 8888.
+Visiting `http://<hostname>:10000/?token=<token>` in a browser loads JupyterLab,
+where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console.
+
+```bash
+docker run -p 10000:8888 jupyter/scipy-notebook:33add21fab64
+```
+
+**Example 3:** This command pulls the `jupyter/datascience-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host.
+It then starts an _ephemeral_ container running a Jupyter Notebook server and exposes the server on host port 10000.
+The command mounts the current working directory on the host as `/home/jovyan/work` in the container.
+The server logs appear in the terminal.
+Visiting `http://<hostname>:10000/?token=<token>` in a browser loads JupyterLab,
+where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console.
+Docker destroys the container after notebook server exit, but any files written to `~/work` in the container remain intact on the host.
+
+```bash
+docker run --rm -p 10000:8888 -e JUPYTER_ENABLE_LAB=yes -v "${PWD}":/home/jovyan/work jupyter/datascience-notebook:33add21fab64
+```
 
 ## Contributing
 
@@ -59,23 +60,21 @@ maintained stacks.
 
 ## Maintainer Help Wanted
 
-We value all positive contributions to the Docker stacks project, from
-[bug reports](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/issues.html) to
-[pull requests](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/packages.html)
-to
-[translations](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/translations.html)
-to help answering questions. We'd also like to invite members of the community to help with two
-maintainer activities:
+We value all positive contributions to the Docker stacks project,
+from [bug reports](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/issues.html)
+to [pull requests](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/packages.html)
+to [translations](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/translations.html)
+to help answering questions.
+We'd also like to invite members of the community to help with two maintainer activities:
 
 - Issue triage: Reading and providing a first response to issues, labeling issues appropriately,
   redirecting cross-project questions to Jupyter Discourse
 - Pull request reviews: Reading proposed documentation and code changes, working with the submitter
   to improve the contribution, deciding if the contribution should take another form (e.g., a recipe
   instead of a permanent change to the images)
 
-Anyone in the community can jump in and help with these activities at any time. We will happily
-grant additional permissions (e.g., ability to merge PRs) to anyone who shows an on-going interest
-in working on the project.
+Anyone in the community can jump in and help with these activities at any time
+We will happily grant additional permissions (e.g., ability to merge PRs) to anyone who shows an on-going interest in working on the project.
 
 ## Jupyter Notebook Deprecation Notice
 
@@ -85,7 +84,8 @@ more information is available in the [documentation](https://jupyter-docker-stac
 
 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.
 
-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.
+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.
 
 This change is tracked in the issue [#1217](https://github.com/jupyter/docker-stacks/issues/1217), please check its content for more information.
 

docs/contributing/features.md

@@ -37,15 +37,14 @@ Roughly speaking, we evaluate new features based on the following criteria:
 If there's agreement that the feature belongs in one or more of the core stacks:
 
 1. Implement the feature in a local clone of the `jupyter/docker-stacks` project.
-2. Please build the image locally before submitting a pull request. Building the image locally
-   shortens the debugging cycle by taking some load off GitHub Actions, which graciously provide
-   free build services for open source projects like this one. If you use `make`, call:
+2. Please build the image locally before submitting a pull request
+   Building the image locally shortens the debugging cycle by taking some load off GitHub Actions, which graciously provide free build services for open source projects like this one.
+   If you use `make`, call:
 
    ```bash
    make build/somestack-notebook
    ```
 
-3. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
-   (PR) with your changes.
+3. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)(PR) with your changes.
 4. Watch for GitHub to report a build success or failure for your PR on GitHub.
 5. Discuss changes with the maintainers and address any build issues.

docs/contributing/issues.md

@@ -1,25 +1,17 @@
 # Project Issues
 
-We appreciate your taking the time to report an issue you encountered using the
-Jupyter Docker Stacks. Please review the following guidelines when reporting
-your problem.
+We appreciate your taking the time to report an issue you encountered using the Jupyter Docker Stacks.
+Please review the following guidelines when reporting your problem.
 
-- If you believe you’ve found a security vulnerability in any of the Jupyter
-  projects included in Jupyter Docker Stacks images, please report it to
-  [[email protected]](mailto:[email protected]), not in the issue trackers
-  on GitHub. If you prefer to encrypt your security reports, you can use [this
-  PGP public
-  key](https://github.com/jupyter/jupyter.github.io/blob/master/assets/ipython_security.asc).
+- If you believe you’ve found a security vulnerability in any of the Jupyter projects included in Jupyter Docker Stacks images,
+  please report it to [[email protected]](mailto:[email protected]), not in the issue trackers on GitHub.
+  If you prefer to encrypt your security reports, you can use [this PGP public key](https://github.com/jupyter/jupyter.github.io/blob/master/assets/ipython_security.asc).
 - If you think your problem is unique to the Jupyter Docker Stacks images,
-  please search the [jupyter/docker-stacks issue
-  tracker](https://github.com/jupyter/docker-stacks/issues) to see if someone
-  else has already reported the same problem. If not, please open a [new
-  issue](https://github.com/jupyter/docker-stacks/issues/new) and provide all of
-  the information requested in the issue template.
-- If the issue you're seeing is with one of the open source libraries included
-  in the Docker images and is reproducible outside the images, please file a bug
-  with the appropriate open source project.
-- If you have a general question about how to use the Jupyter Docker Stacks in
-  your environment, in conjunction with other tools, with customizations, and so
-  on, please post your question on the [Jupyter Discourse
-  site](https://discourse.jupyter.org).
+  please search the [jupyter/docker-stacks issue tracker](https://github.com/jupyter/docker-stacks/issues)
+  to see if someone else has already reported the same problem.
+  If not, please open a [new issue](https://github.com/jupyter/docker-stacks/issues/new) and provide all of the information requested in the issue template.
+- If the issue you're seeing is with one of the open source libraries included in the Docker images and is reproducible outside the images,
+  please file a bug with the appropriate open source project.
+- If you have a general question about how to use the Jupyter Docker Stacks in your environment,
+  in conjunction with other tools, with customizations, and so on,
+  please post your question on the [Jupyter Discourse site](https://discourse.jupyter.org).

docs/contributing/lint.md

@@ -51,7 +51,9 @@ The following rules are ignored by default for all images in the `.hadolint.yaml
 
 For other rules, the preferred way to do it is to flag ignored rules in the `Dockerfile`.
 
-> It is also possible to ignore rules by using a special comment directly above the Dockerfile instruction you want to make an exception for. Ignore rule comments look like `# hadolint ignore=DL3001,SC1081`. For example:
+> It is also possible to ignore rules by using a special comment directly above the Dockerfile instruction you want to make an exception for.
+> Ignore rule comments look like `# hadolint ignore=DL3001,SC1081`.
+> For example:
 
 ```dockerfile
 FROM ubuntu

docs/contributing/packages.md

@@ -9,13 +9,13 @@ Please follow the process below to update a package version:
 1. Locate the Dockerfile containing the library you wish to update (e.g.,
    [base-notebook/Dockerfile](https://github.com/jupyter/docker-stacks/blob/master/base-notebook/Dockerfile),
    [scipy-notebook/Dockerfile](https://github.com/jupyter/docker-stacks/blob/master/scipy-notebook/Dockerfile))
-2. Adjust the version number for the package. We prefer to pin the major and minor version number of
-   packages so as to minimize rebuild side-effects when users submit pull requests (PRs). For
-   example, you'll find the Jupyter Notebook package, `notebook`, installed using conda with
+2. Adjust the version number for the package.
+   We prefer to pin the major and minor version number of packages so as to minimize rebuild side-effects when users submit pull requests (PRs).
+   For example, you'll find the Jupyter Notebook package, `notebook`, installed using conda with
    `notebook=5.4.*`.
-3. Please build the image locally before submitting a pull request. Building the image locally
-   shortens the debugging cycle by taking some load off GitHub Actions, which graciously provide
-   free build services for open source projects like this one. If you use `make`, call:
+3. Please build the image locally before submitting a pull request.
+   Building the image locally shortens the debugging cycle by taking some load off GitHub Actions, which graciously provide free build services for open source projects like this one.
+   If you use `make`, call:
 
    ```bash
    make build/somestack-notebook
@@ -24,13 +24,14 @@ Please follow the process below to update a package version:
 4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request)
    (PR) with your changes.
 5. Watch for GitHub to report a build success or failure for your PR on GitHub.
-6. Discuss changes with the maintainers and address any build issues. Version conflicts are the most
-   common problem. You may need to upgrade additional packages to fix build failures.
+6. Discuss changes with the maintainers and address any build issues.
+   Version conflicts are the most common problem.
+   You may need to upgrade additional packages to fix build failures.
 
 ## Notes
 
-In order to help identifying packages that can be updated you can use the following helper tool. It
-will list all the packages installed in the `Dockerfile` that can be updated -- dependencies are
+In order to help identifying packages that can be updated you can use the following helper tool.
+It will list all the packages installed in the `Dockerfile` that can be updated -- dependencies are
 filtered to focus only on requested packages.
 
 ```bash

docs/contributing/recipes.md

@@ -1,8 +1,10 @@
 # New Recipes
 
-We welcome contributions of [recipes](../using/recipes.md), short examples of using, configuring, or extending the Docker Stacks, for inclusion in the documentation site. Follow the process below to add a new recipe:
+We welcome contributions of [recipes](../using/recipes.md), short examples of using, configuring, or extending the Docker Stacks, for inclusion in the documentation site.
+Follow the process below to add a new recipe:
 
 1. Open the `docs/using/recipes.md` source file.
 2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Add the RISE extension`)
 3. Write the body of your recipe under the heading, including whatever command line, Dockerfile, links, etc. you need.
-4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request) (PR) with your changes. Maintainers will respond and work with you to address any formatting or content issues.
+4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request) (PR) with your changes.
+   Maintainers will respond and work with you to address any formatting or content issues.