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

Fix some minor issues in docs

Browse Source
This commit is contained in:
Ayaz Salikhov
2025-02-24 16:59:47 +00:00
parent 955ee9f987
commit fc542dae88
11 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/features.md
View File

@@ -53,6 +53,6 @@ If there's agreement that the feature belongs in one or more of the core stacks:
make build/<somestack>
```
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.

2
docs/contributing/issues.md
View File

@@ -1,6 +1,6 @@
# Project Issues
We appreciate your taking the time to report an issue you encountered using the Jupyter Docker Stacks.
We appreciate you taking the time to report an issue you encountered while 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,

6
docs/contributing/lint.md
View File

@@ -27,10 +27,10 @@ pre-commit install
### Run
Now, _pre-commit_ (and so configured hooks) will run automatically on `git commit` on each changed file.
However, it is also possible to trigger it against all files.
However, you can also run it against all files manually.
```{note}
Hadolint pre-commit uses Docker to run, so `docker` should be running while running this command.
Hadolint pre-commit uses Docker to run, so `docker` should be running while executing this command.
```
```sh
@@ -58,7 +58,7 @@ The following rules are ignored by default for all images in the `.hadolint.yaml
- [`DL3008`][dl3008]: System packages are always updated (`apt-get`) to the latest version.
- [`DL3013`][dl3013]: We always install the latest packages using `pip`
The preferred way to do it for other rules is to flag ignored ones in the `Dockerfile`.
The preferred way to ignore other rules is to flag them 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`.

4
docs/contributing/packages.md
View File

@@ -12,8 +12,8 @@ We pin major.minor version of Python, so this will stay the same even after invo
## Outdated packages
To help identify packages that can be updated, you can use the following helper tool.
It will list all the outdated packages installed in the `Dockerfile` --
dependencies are filtered to focus only on requested packages.
It will list all the outdated packages installed in the `Dockerfile`.
Dependencies are filtered to display only the requested packages.
```bash
make check-outdated/base-notebook

2
docs/contributing/recipes.md
View File

@@ -1,6 +1,6 @@
# New Recipes
We welcome contributions of [recipes](../using/recipes.md), and short examples of using, configuring, or extending the Docker Stacks for inclusion in the documentation site.
We welcome contributions of [recipes](../using/recipes.md), which are 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.

6
docs/contributing/stacks.md
View File

@@ -35,8 +35,8 @@ This will serve as both the git repository name and the part of the Docker image
stack_name [my-jupyter-stack]:
```
Enter the user or organization name under which this stack will reside on Quay.io.
You must have access to manage this Quay.io organization to push images here.
Enter the user or organization name under which this stack will reside on Docker Hub.
You must have access to manage this Docker Hub organization to push images here.
```text
stack_org [my-project]:
@@ -150,5 +150,5 @@ Finally, if you'd like to add a link to your project to this documentation site,
1. Fork the [jupyter/docker-stacks](https://github.com/jupyter/docker-stacks) GitHub repository.
2. Open the `docs/using/selecting.md` source file and locate the **Community Stacks** section in your fork.
3. Add a table entry with a link to your project, a binder link, and a short description of what your Docker image contains.
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.
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.