Skip to content

[docs-scanner] Contradictory statements about Notary deployment documentation availability #25145

@github-actions

Description

@github-actions

File: content/manuals/engine/security/trust/deploying_notary.md

Issue

The page contains contradictory statements about whether comprehensive Notary deployment documentation exists:

Early in the page (step 2):

For more detailed documentation about how to deploy Notary Server, see the instructions to run a Notary service as well as the Notary repository for more information.

But later in the "If you want to use Notary in production" section:

Check back here for instructions after Notary Server has an official stable release.

Why this matters

A reader trying to deploy Notary in production receives conflicting guidance:

  • First they're told detailed deployment documentation exists (in the external Notary repository)
  • Then they're told to "check back" for instructions that don't exist yet

This creates confusion about whether production deployment is documented or not, and whether the external Notary repository documentation is sufficient for production use.

Suggested fix

Clarify the documentation status:

If the external Notary repository documentation is sufficient for production deployment, remove the "check back here" statement and make it clear that readers should follow the external documentation.

If the external documentation is incomplete for production use, update the earlier reference to be more specific about what's available versus what's missing. For example: "For basic deployment information, see the Notary repository. Production deployment guidance is being developed."


Found by nightly documentation quality scanner

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions