Skip to content

add docs for staged configs phase 2 #489

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

vivki
Copy link
Contributor

@vivki vivki commented May 2, 2025

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: Give a brief overview of the problem or feature being addressed.

Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
considerations.

Testing: Describe any testing that you did.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

@vivki vivki requested a review from a team as a code owner May 2, 2025 16:42
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 2, 2025
@vivki vivki marked this pull request as draft May 2, 2025 16:42
@mjang
Copy link
Contributor

mjang commented May 2, 2025

@vivki Thanks for the draft. I see (at least most) of what you're doing for import/export with the following "flag": "staged-configs-phase-2"

I presume that feature flag still blocks what's shown in the API docs. (You can see for yourself. Take your repo, and follow the steps in https://github.com/nginx/documentation/blob/main/CONTRIBUTING_DOCS.md. Run the make watch command, and you'll have a local build in localhost:1313.

@vivki vivki force-pushed the sc-phase2-docs branch from 4184d32 to bbfb1e3 Compare May 13, 2025 17:49
@mjang mjang marked this pull request as ready for review May 13, 2025 19:19
@mjang mjang added the product/nginx-one NGINX One Console label May 13, 2025
@mjang
Copy link
Contributor

mjang commented May 13, 2025

Updates work for me, thanks @vivki ! I'll post in the internal nginx-docs-reviews channel for a 2nd approval.

@mjang
Copy link
Contributor

mjang commented May 15, 2025

@vivki , I propose that we supersede this PR with #553 (I've included your one.json there). It allows us to test some of the X-links from the main doc to the API reference.

@mjang mjang marked this pull request as draft May 15, 2025 14:02
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 product/nginx-one NGINX One Console
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants