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

Fix more errors

Browse Source
This commit is contained in:
Ayaz Salikhov
2021-05-01 13:07:40 +03:00
parent bf5ec600d1
commit c2031e2a4a
18 changed files with 34 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/contributing/lint.md
View File

@@ -6,7 +6,7 @@ To integrate and enforce this process in the project lifecycle we are using **gi
## Pre-commit hook
### Installation
### Pre-commit hook installation
pre-commit is a Python package that needs to be installed.
This can be achieved by using the generic task used to install all Python development dependencies.
@@ -21,7 +21,7 @@ $ pip install pre-commit
Then the git hooks scripts configured for the project in `.pre-commit-config.yaml` need to be installed in the local git repository.
```sh
$ make pre-commit-install
make pre-commit-install
```
### Run
@@ -30,14 +30,14 @@ Now pre-commit (and so configured hooks) will run automatically on `git commit`
However it is also possible to trigger it against all files.
```sh
$ make pre-commit-all
make pre-commit-all
```
## Image Lint
To comply with [Docker best practices][dbp], we are using the [Hadolint][hadolint] tool to analyse each `Dockerfile` .
### Installation
### Hadolint installation
There is a specific `make` target to install the linter.
By default `hadolint` will be installed in `${HOME}/hadolint`.
@@ -81,7 +81,7 @@ $ make hadolint/scipy-notebook ARGS="--format codeclimate"
The linter can be run against all the stacks.
```bash
$ make hadolint-all
make hadolint-all
```
### Ignoring Rules

2
docs/contributing/translations.md
View File

@@ -3,5 +3,5 @@
We are delighted when members of the Jupyter community want to help translate these documentation pages to other languages. If you're interested, please visit links below below to join our team on [Transifex](https://transifex.com) and to start creating, reviewing, and updating translations of the Jupyter Docker Stacks documentation.
1. Follow the steps documented on the [Getting Started as a Translator](https://docs.transifex.com/getting-started-1/translators) page.
2. Look for *jupyter-docker-stacks* when prompted to choose a translation team. Alternatively, visit https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1 after creating your account and request to join the project.
2. Look for *jupyter-docker-stacks* when prompted to choose a translation team. Alternatively, visit <https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1> after creating your account and request to join the project.
3. See [Translating with the Web Editor](https://docs.transifex.com/translation/translating-with-the-web-editor) in the Transifex documentation.