hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-08 10:34:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use mdlint rules [WIP]

Browse Source
This commit is contained in:
Ayaz Salikhov
2021-05-01 12:52:41 +03:00
parent dfcb043bd8
commit bf5ec600d1
18 changed files with 46 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.github/issue_template.md vendored
View File

@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD041 -->
Hi! Thanks for using the Jupyter Docker Stacks.
Please review the following guidance about how to ask questions, contribute changes, or report bugs in the Docker images maintained here.
@@ -20,7 +21,7 @@ Example: `docker run -it --rm -p 8889:8888 jupyter/all-spark-notebook:latest`
Example:
1. Visit http://localhost:8888
1. Visit <http://localhost:8888>
2. Start an R notebook
3. ...

7
.markdownlint.yaml Normal file
View File

@@ -0,0 +1,7 @@
# Default state for all rules
default: true
# MD013/line-length - Line length
MD013:
# Number of characters
line_length: 1000

4
.pre-commit-config.yaml
View File

@@ -24,3 +24,7 @@ repos:
rev: v1.5.6
hooks:
- id: autopep8
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.27.1
hooks:
- id: markdownlint

2
CODE_OF_CONDUCT.md
View File

@@ -1 +1,3 @@
# Project `jupyter/docker-stacks` Code of Conduct
Please see the [Project Jupyter Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).

2
CONTRIBUTING.md
View File

@@ -1,3 +1,5 @@
<!-- markdownlint-disable MD041 -->
Thanks for contributing! Please see the
__Contributor Guide__ section in [the documentation](https://jupyter-docker-stacks.readthedocs.io) for
information about how to contribute

4
README.md
View File

@@ -1,10 +1,10 @@
# Jupyter Docker Stacks
[![Discourse badge](https://img.shields.io/discourse/https/discourse.jupyter.org/users.svg?color=%23f37626)](https://discourse.jupyter.org/c/questions "Jupyter Discourse Q&A")
[![Read the Docs badge](https://img.shields.io/readthedocs/jupyter-docker-stacks.svg)](https://jupyter-docker-stacks.readthedocs.io/en/latest/ "Documentation build status")
[![DockerHub badge](https://images.microbadger.com/badges/version/jupyter/base-notebook.svg)](https://microbadger.com/images/jupyter/base-notebook "Recent tag/version of jupyter/base-notebook")
[![Binder badget](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/docker-stacks/master?filepath=README.ipynb "Launch a jupyter/base-notebook container on mybinder.org")
# Jupyter Docker Stacks
Jupyter Docker Stacks are a set of ready-to-run [Docker images](https://hub.docker.com/u/jupyter)
containing Jupyter applications and interactive computing tools.

4
all-spark-notebook/README.md
View File

@@ -1,9 +1,9 @@
# Jupyter Notebook Python, Scala, R, Spark Stack
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/all-spark-notebook.svg)](https://hub.docker.com/r/jupyter/all-spark-notebook/)
[![docker stars](https://img.shields.io/docker/stars/jupyter/all-spark-notebook.svg)](https://hub.docker.com/r/jupyter/all-spark-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/all-spark-notebook.svg)](https://microbadger.com/images/jupyter/all-spark-notebook "jupyter/all-spark-notebook image metadata")
# Jupyter Notebook Python, Scala, R, Spark Stack
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
to Docker Hub.

4
base-notebook/README.md
View File

@@ -1,9 +1,9 @@
# Base Jupyter Notebook Stack
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/base-notebook.svg)](https://hub.docker.com/r/jupyter/base-notebook/)
[![docker stars](https://img.shields.io/docker/stars/jupyter/base-notebook.svg)](https://hub.docker.com/r/jupyter/base-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/base-notebook.svg)](https://microbadger.com/images/jupyter/base-notebook "jupyter/base-notebook image metadata")
# Base Jupyter Notebook Stack
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
to Docker Hub.

4
datascience-notebook/README.md
View File

@@ -1,9 +1,9 @@
# Jupyter Notebook Data Science Stack
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/datascience-notebook.svg)](https://hub.docker.com/r/jupyter/datascience-notebook/)
[![docker stars](https://img.shields.io/docker/stars/jupyter/datascience-notebook.svg)](https://hub.docker.com/r/jupyter/datascience-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/datascience-notebook.svg)](https://microbadger.com/images/jupyter/datascience-notebook "jupyter/datascience-notebook image metadata")
# Jupyter Notebook Data Science Stack
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
to Docker Hub.

2
examples/docker-compose/README.md
View File

@@ -1,3 +1,5 @@
# Docker Compose example
This example demonstrate how to deploy docker-stack notebook containers to any Docker Machine-controlled host using Docker Compose.
## Prerequisites

2
examples/make-deploy/README.md
View File

@@ -1,3 +1,5 @@
# Make deploy example
This folder contains a Makefile and a set of supporting files demonstrating how to run a docker-stack notebook container on a docker-machine controlled host.
## Prerequisites

5
examples/openshift/README.md
View File

@@ -1,3 +1,6 @@
OpenShift example
=================
This example provides templates for deploying the Jupyter Project docker-stacks images to OpenShift.
Prerequsites
@@ -221,7 +224,7 @@ If using a persistent volume, you could instead setup a password in the file:
as per guidelines in:
* https://jupyter-notebook.readthedocs.io/en/stable/public_server.html
* <https://jupyter-notebook.readthedocs.io/en/stable/public_server.html>
Deploying from a Custom Image
-----------------------------

3
examples/source-to-image/README.md
View File

@@ -1,3 +1,6 @@
Custom Jupyter Notebook images
==============================
This example provides scripts for building custom Jupyter Notebook images containing notebooks, data files, and with Python packages required by the notebooks already installed. The scripts provided work with the Source-to-Image tool and you can create the images from the command line on your own computer. Templates are also provided to enable running builds in OpenShift, as well as deploying the resulting image to OpenShift to make it available.
The build scripts, when used with the Source-to-Image tool, provide similar capabilities to ``repo2docker``. When builds are run under OpenShift with the supplied templates, it provides similar capabilities to ``mybinder.org``, but where notebook instances are deployed in your existing OpenShift project and JupyterHub is not required.

4
minimal-notebook/README.md
View File

@@ -1,9 +1,9 @@
# Minimal Jupyter Notebook Stack
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/minimal-notebook.svg)](https://hub.docker.com/r/jupyter/minimal-notebook/)
[![docker stars](https://img.shields.io/docker/stars/jupyter/minimal-notebook.svg)](https://hub.docker.com/r/jupyter/minimal-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/minimal-notebook.svg)](https://microbadger.com/images/jupyter/minimal-notebook "jupyter/minimal-notebook image metadata")
# Minimal Jupyter Notebook Stack
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
to Docker Hub.

4
pyspark-notebook/README.md
View File

@@ -1,9 +1,9 @@
# Jupyter Notebook Python, Spark Stack
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/pyspark-notebook.svg)](https://hub.docker.com/r/jupyter/pyspark-notebook/)
[![docker stars](https://img.shields.io/docker/stars/jupyter/pyspark-notebook.svg)](https://hub.docker.com/r/jupyter/pyspark-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/pyspark-notebook.svg)](https://microbadger.com/images/jupyter/pyspark-notebook "jupyter/pyspark-notebook image metadata")
# Jupyter Notebook Python, Spark Stack
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
to Docker Hub.

4
r-notebook/README.md
View File

@@ -1,9 +1,9 @@
# Jupyter Notebook R Stack
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/r-notebook.svg)](https://hub.docker.com/r/jupyter/r-notebook/)
[![docker stars](https://img.shields.io/docker/stars/jupyter/r-notebook.svg)](https://hub.docker.com/r/jupyter/r-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/r-notebook.svg)](https://microbadger.com/images/jupyter/r-notebook "jupyter/r-notebook image metadata")
# Jupyter Notebook R Stack
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
to Docker Hub.

4
scipy-notebook/README.md
View File

@@ -1,9 +1,9 @@
# Jupyter Notebook Scientific Python Stack
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/scipy-notebook.svg)](https://hub.docker.com/r/jupyter/scipy-notebook/)
[![docker stars](https://img.shields.io/docker/stars/jupyter/scipy-notebook.svg)](https://hub.docker.com/r/jupyter/scipy-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/scipy-notebook.svg)](https://microbadger.com/images/jupyter/scipy-notebook "jupyter/scipy-notebook image metadata")
# Jupyter Notebook Scientific Python Stack
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
to Docker Hub.

4
tensorflow-notebook/README.md
View File

@@ -1,9 +1,9 @@
# Jupyter Notebook Deep Learning Stack
[![docker pulls](https://img.shields.io/docker/pulls/jupyter/tensorflow-notebook.svg)](https://hub.docker.com/r/jupyter/tensorflow-notebook/)
[![docker stars](https://img.shields.io/docker/stars/jupyter/tensorflow-notebook.svg)](https://hub.docker.com/r/jupyter/tensorflow-notebook/)
[![image metadata](https://images.microbadger.com/badges/image/jupyter/tensorflow-notebook.svg)](https://microbadger.com/images/jupyter/tensorflow-notebook "jupyter/tensorflow-notebook image metadata")
# Jupyter Notebook Deep Learning Stack
GitHub Actions in the https://github.com/jupyter/docker-stacks project builds and pushes this image
to Docker Hub.