diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3a1a046a..25802250 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -28,3 +28,4 @@ repos: rev: v0.27.1 hooks: - id: markdownlint + args: ['--fix'] diff --git a/docs/contributing/features.md b/docs/contributing/features.md index 4cdc23d1..61a183b3 100644 --- a/docs/contributing/features.md +++ b/docs/contributing/features.md @@ -40,9 +40,11 @@ If there's agreement that the feature belongs in one or more of the core stacks: 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. 4. Watch for GitHub to report a build success or failure for your PR on GitHub. diff --git a/docs/contributing/packages.md b/docs/contributing/packages.md index f6e717db..edfad60f 100644 --- a/docs/contributing/packages.md +++ b/docs/contributing/packages.md @@ -16,9 +16,11 @@ Please follow the process below to update a package version: 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 ``` + 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. diff --git a/docs/contributing/tests.md b/docs/contributing/tests.md index 36bdfdf7..ea0a4e67 100644 --- a/docs/contributing/tests.md +++ b/docs/contributing/tests.md @@ -23,10 +23,12 @@ Please follow the process below to add new tests: 2. If your test should run against a single image, add your test code to one of the modules in `some-notebook/test/` or create a new module. 3. Build one or more images you intend to test and run the tests locally. If you use `make`, call: + ```bash make build/somestack-notebook make test/somestack-notebook ``` + 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. diff --git a/docs/using/recipes.md b/docs/using/recipes.md index f64c51f8..affc6de9 100644 --- a/docs/using/recipes.md +++ b/docs/using/recipes.md @@ -166,11 +166,13 @@ ENTRYPOINT ["jupyter", "lab", "--ip=0.0.0.0", "--allow-root"] ``` And build the image as: + ```bash docker build -t jupyter/scipy-dasklabextension:latest . ``` Once built, run using the command: + ```bash docker run -it --rm -p 8888:8888 -p 8787:8787 jupyter/scipy-dasklabextension:latest ``` @@ -273,6 +275,7 @@ ARG BASE_CONTAINER=ubuntu:focal-20200423@sha256:238e696992ba9913d24cfc3727034985 ``` For Ubuntu 18.04 (bionic) and earlier, you may also require to workaround for a mandb bug, which was fixed in mandb >= 2.8.6.1: + ```dockerfile # https://git.savannah.gnu.org/cgit/man-db.git/commit/?id=8197d7824f814c5d4b992b4c8730b5b0f7ec589a # http://launchpadlibrarian.net/435841763/man-db_2.8.5-2_2.8.6-1.diff.gz