Skip to content

Apply review suggestions to the plone/nick image page - #2120

Merged
ericof merged 1 commit into
6.0from
nick-docs-review
Oct 31, 2026
Merged

ericof merged 1 commit into
6.0from
nick-docs-review

Conversation

@ericof

@ericof ericof commented Oct 31, 2026

Copy link
Copy Markdown
Member

Follow-up to #2119, which merged before the review from @stevepiercy finished. This applies the suggestions on docs/install/containers/images/nick.md. Wording and punctuation suggestions went in as written, and the same serial commas were applied to two other lists on the page.

Answers to the questions:

  • How should DB_PASSWORD and SECRET be set? As environment variables, with the -e option of docker run. The page now says so.
  • Accuracy of the docker rm and docker volume rm suggestion: checked on Docker 29.9.1. Both commands need names, so the page uses the containers and volumes from its example. docker rm refuses a running container, so the example stops them first. docker volume rm also refuses a volume that a stopped container references, which the page now says.
  • Intersphinx: not available. The Nick documentation is built with Jekyll and publishes no objects.inv, so those links stay as plain URLs.

One suggestion changed: docker run plone/nick -e NICK_MODULES=api passes -e to the image's command instead of to Docker, so the variable isn't set. The page uses docker run -e NICK_MODULES=api plone/nick.

Refs #2118

Follow-up to #2119 with the changes stevepiercy requested. Say how to
pass the required variables, show the commands that remove containers
and volumes, and put the environment variable option before the image
name, where docker run reads it.

@stevepiercy stevepiercy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care!

```

It's not possible to remove a volume that a container references, even if that container is stopped.
Remove the containers first.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the revision. This is much clearer to n00bs.

@stevepiercy

Copy link
Copy Markdown
Member

OK to merge. Broken links are temporary.

@ericof
ericof merged commit bc7c29c into 6.0 Oct 31, 2026
2 of 3 checks passed
@ericof
ericof deleted the nick-docs-review branch October 31, 2026 13:43
@github-project-automation github-project-automation Bot moved this from New to Done in Plone Documentation Oct 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants