Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mjang opened this issue Apr 10, 2025 · 0 comments
Open

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

mjang opened this issue Apr 10, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mjang
Copy link
Contributor

mjang commented Apr 10, 2025

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

@mjang mjang added the documentation Improvements or additions to documentation label Apr 10, 2025
@mjang mjang self-assigned this Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant