Skip to content

Write the Docs planning: Request for Docs as Tests review #387

@mjang

Description

@mjang

Overview

As a technical writer, we would like to automate the reviews of as much of our documentation as possible. We're having external discussions on the process, specifically with Manny Silva ( @hawkeyexl ) , author of Docs as Tests

We would like Manny to target our NGINX One Workshops, at https://github.com/nginxinc/nginx-one-workshops, which we plan to move to our product documentation as part of this repository (https://github.com/nginx/documentation ).

Ideally, with the Docs as Tests process, we'd be able to:

  1. Confirm that the current NGINX One Workshops ( https://github.com/nginxinc/nginx-one-workshops) actually works
  2. Continue to confirm that the steps described in the workshops continue to work when we move the content to this repository.
    • As we incorporate content that meet our technical writing standards, we'd appreciate help with tests that confirm that the "steps" still work with the changes that we make.

Description

Acceptance criteria

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions