Skip to content

Update CLI documentation#1309

Merged
mattias-p merged 6 commits into
zonemaster:developfrom
mattias-p:68-brief
Nov 20, 2024
Merged

Update CLI documentation#1309
mattias-p merged 6 commits into
zonemaster:developfrom
mattias-p:68-brief

Conversation

@mattias-p

Copy link
Copy Markdown
Member

Purpose

This PR updates the end user documentation for CLI on how to get brief and full command line documentation.

Context

This the sister PR of zonemaster/zonemaster-cli#389.

Changes

  • docs/public/using/cli.md

How to test this PR

Run the commands in the update and make sure they match the description.

@mattias-p mattias-p added the V-Patch Versioning: The change gives an update of patch in version. label Nov 13, 2024
@mattias-p mattias-p added this to the v2024.2 milestone Nov 13, 2024
Comment thread docs/public/using/cli.md Outdated
@mattias-p mattias-p changed the title Update CLI usage documentation Update CLI documentation Nov 13, 2024
Co-authored-by: Marc van der Wal <103426270+marc-vanderwal@users.noreply.github.com>
@mattias-p mattias-p added the P-High Priority: Issue to be solved before other label Nov 15, 2024

@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.

Besides the comment it looks fine.

Comment thread docs/public/development/cli.md Outdated
@matsduf

matsduf commented Nov 18, 2024

Copy link
Copy Markdown
Contributor

Besides, every directory in the public tree must have a README.md and all files in the public tree must be linked from SUMMARY.md (except SUMMARY.md and book.toml).

Maybe we should have a CI for this repository, though the link checking does not seem to be black or white.

@matsduf matsduf modified the milestones: v2024.2, v2025.1 Nov 19, 2024
@mattias-p mattias-p requested a review from matsduf November 19, 2024 15:00

@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.

It looks good, just one small comment.

Comment thread docs/public/using/cli.md Outdated
@matsduf matsduf dismissed their stale review November 19, 2024 16:41

Now it is good enough, just one minor comment.

@tgreenx tgreenx 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.

One typo otherwise LGTM

Comment thread docs/public/development/cli.md Outdated
mattias-p and others added 2 commits November 20, 2024 10:28
Co-authored-by: Mats Dufberg <mats.dufberg@iis.se>
Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
@mattias-p mattias-p merged commit 8fc4477 into zonemaster:develop Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P-High Priority: Issue to be solved before other V-Patch Versioning: The change gives an update of patch in version.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants