Skip to content

Documentation for Docker zonemaster-backend #1441

Merged
MichaelTimbert merged 38 commits into
zonemaster:developfrom
MichaelTimbert:doc-docker-backend
Dec 8, 2025
Merged

Documentation for Docker zonemaster-backend #1441
MichaelTimbert merged 38 commits into
zonemaster:developfrom
MichaelTimbert:doc-docker-backend

Conversation

@MichaelTimbert

Copy link
Copy Markdown
Contributor

Purpose

This PR update documentation for docker release process and add documentation for the new zonemaster-backend image.

Context

Follow-up PR on zonemaster-backend zonemaster/zonemaster-backend#1225

MichaelTimbert and others added 4 commits November 18, 2025 10:15
Updated the documentation for using Zonemaster Backend with Docker, including new sections for invoking zmtest and zmb, and improved clarity on Docker usage and IPv6 support.
@MichaelTimbert MichaelTimbert added this to the v2025.2 milestone Nov 18, 2025
@MichaelTimbert MichaelTimbert added the A-Documentation Area: Documentation only. label Nov 18, 2025

@matsduf matsduf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I will do more review.

Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
@matsduf matsduf added the RC-Features Release category: Features. label Nov 25, 2025
Comment thread docs/internal/maintenance/ReleaseProcess-create-docker-image.md

@matsduf matsduf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

When documents under "public" are added, moved, renamed or removed then https://github.com/zonemaster/zonemaster/blob/develop/docs/public/SUMMARY.md must also be updated.

Comment thread docs/internal/maintenance/ReleaseProcess-create-docker-image.md
Comment thread docs/public/using/backend/README.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/internal/maintenance/ReleaseProcess-create-docker-image.md
MichaelTimbert and others added 11 commits December 2, 2025 15:00
Co-authored-by: Mats Dufberg <mats.dufberg@iis.se>
Updated link to Docker Zonemaster-Backend documentation.
Co-authored-by: Marc van der Wal <103426270+marc-vanderwal@users.noreply.github.com>
Co-authored-by: Marc van der Wal <103426270+marc-vanderwal@users.noreply.github.com>
Co-authored-by: Marc van der Wal <103426270+marc-vanderwal@users.noreply.github.com>
Co-authored-by: Marc van der Wal <103426270+marc-vanderwal@users.noreply.github.com>
Co-authored-by: Marc van der Wal <103426270+marc-vanderwal@users.noreply.github.com>
Co-authored-by: Marc van der Wal <103426270+marc-vanderwal@users.noreply.github.com>

@matsduf matsduf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I have two additions on commands to get documentation on zmb and zmtest. Besides that it looks fine.

Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md
MichaelTimbert and others added 2 commits December 3, 2025 15:44
Co-authored-by: Mats Dufberg <mats.dufberg@iis.se>
Co-authored-by: Mats Dufberg <mats.dufberg@iis.se>
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/internal/maintenance/ReleaseProcess-create-docker-image.md Outdated
Comment thread docs/internal/maintenance/ReleaseProcess-create-docker-image.md Outdated
Comment thread docs/internal/maintenance/ReleaseProcess-create-docker-image.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
Comment thread docs/public/using/cli.md Outdated
Comment thread docs/public/SUMMARY.md Outdated
Comment thread docs/public/using/backend/Using-Zonemaster-Backend-Docker.md Outdated
@matsduf

matsduf commented Dec 7, 2025

Copy link
Copy Markdown
Contributor

The following sentence is found in the overview section of the installation instruction for CLI:

An alternative to installing Zonemaster-CLI is to run it under Docker. See Using the CLI for run it under Docker.

Could this PR add a similar sentence to the installation document for Backend?

MichaelTimbert and others added 8 commits December 8, 2025 09:30
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
@MichaelTimbert

Copy link
Copy Markdown
Contributor Author

The following sentence is found in the overview section of the installation instruction for CLI:

An alternative to installing Zonemaster-CLI is to run it under Docker. See Using the CLI for run it under Docker.

Could this PR add a similar sentence to the installation document for Backend?

Done.

MichaelTimbert and others added 5 commits December 8, 2025 10:08
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
@matsduf

matsduf commented Dec 8, 2025

Copy link
Copy Markdown
Contributor

@MichaelTimbert, please merge.

@MichaelTimbert MichaelTimbert merged commit 26db235 into zonemaster:develop Dec 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Documentation Area: Documentation only. RC-Features Release category: Features.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants