-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1379 from mathbunnyru/asalikhov/docs_long_lines
Limit markdown line length to 200
- Loading branch information
Showing
22 changed files
with
465 additions
and
307 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,4 +4,4 @@ default: true | |
# MD013/line-length - Line length | ||
MD013: | ||
# Number of characters | ||
line_length: 1000 | ||
line_length: 200 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
[security@ipython.org](mailto:security@iypthon.org), 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 [security@ipython.org](mailto:security@iypthon.org), 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
Oops, something went wrong.