Skip to content

Port and Publish NGINX One Workshop Labs to Public Documentation #472

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
1 of 3 tasks
travisamartin opened this issue Apr 29, 2025 · 1 comment
Open
1 of 3 tasks
Assignees
Labels
customer-success documentation Improvements or additions to documentation epic onboarding

Comments

@travisamartin
Copy link
Contributor

travisamartin commented Apr 29, 2025

Goal

Port the NGINX One onboarding labs from the private nginx-one-workshops repository into the public NGINX documentation repository, to enable self-service onboarding for users.

Background

The labs in nginx-one-workshops/labs were developed by the Customer Success team to guide users through common NGINX One workflows. To make these resources more accessible and integrated into our broader documentation set, we will migrate, edit, and publish them in the official public documentation repo.

This work supports our goal of enabling scalable, self-service onboarding and reducing dependency on live support.

Deliverables

  • Add Apache License to the root of the /content/nginx-one/workshops/ directory
  • Port each lab (0005) to the public documentation repo
  • Edit each lab to align with NGINX and F5 style guidelines:
    • Ensure clarity and consistency
    • Reduce the number of screenshots
    • Use plain language and follow formatting best practices

Each lab will be tracked in a sub-issue linked below.

Proposed Documentation Location

/content/nginx-one/workshops/

Each lab should live in its own directory. Include a shared overview or index page to guide users through the full set.

Editorial Guidance

  • Follow the NGINX and F5 style guides
  • Minimize screenshots; describe UI or CLI steps with concise text
  • Ensure users understand the expected outcomes of each lab step
@travisamartin travisamartin added customer-success documentation Improvements or additions to documentation epic onboarding labels Apr 29, 2025
@travisamartin travisamartin self-assigned this Apr 29, 2025
@RoughlyHewn
Copy link

I'm interested in assisting with this project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-success documentation Improvements or additions to documentation epic onboarding
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants