Skip to content

chore: Add template milestone 3 updates#1965

Open
CodeMonkeyF5 wants to merge 10 commits into
nginx:mainfrom
CodeMonkeyF5:main
Open

chore: Add template milestone 3 updates#1965
CodeMonkeyF5 wants to merge 10 commits into
nginx:mainfrom
CodeMonkeyF5:main

Conversation

@CodeMonkeyF5
Copy link
Copy Markdown

@CodeMonkeyF5 CodeMonkeyF5 commented May 17, 2026

Proposed changes

Config Templates — UI screens, submission persistence, and template management

New files

  • template-detail-view.md — Documents the Template Detail page (Details tab): field descriptions, tmpl_ vs tmplv_ identifier guidance, and API reference.
  • template-versions.md — Documents the Versions tab: data grid columns, delete constraints, and API references.
  • template-submissions-view.md — Documents the Submissions view (Details tab): data grid columns and delete action.

Updated files

  • one.json — Latest regenerated with x-nodoc removed for templates m3 APIs
  • author-templates.md — Updated "Template Submission" glossary entry; added "Static include files" subsection documenting file_type: include; removed outdated external-file limitations; added "Template lifecycle management" section covering updateTemplateMetadata, patchTemplateMetadata (with draft→final irreversibility callout), and copyTemplate.
  • import-templates.md — Updated archive structure to support static include files; updated tips section restoring the "avoid hidden/backup files" example (with .conf/.types in the correct example) and added a new tip for bundling include files.
  • submit-templates.md — Removed "Current Limitations" section; split request into submission mode (preview_only=false, default) and preview mode (preview_only=true); added current limitation callout (targets limited to staged configs); added "Manage template submissions" section covering getTemplateSubmission, updateTemplateSubmission, updateSingleTemplateSubmission, and deleteTemplateSubmission.
  • save-as-staged-config.md — Reframed: direct submission is now the recommended approach; preview-then-manual-create retained as the alternative workflow.
  • add-multiple-services.md — Updated stale callout to reflect that submissions are now persistent and retrievable.

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@CodeMonkeyF5 CodeMonkeyF5 requested a review from a team as a code owner May 17, 2026 15:03
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 17, 2026

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@github-actions github-actions Bot added documentation Improvements or additions to documentation product/nginx-one-console Issues related to NGINX One Console labels May 17, 2026
@CodeMonkeyF5
Copy link
Copy Markdown
Author

I have hereby read the F5 CLA and agree to its terms

Copy link
Copy Markdown

@syousF5 syousF5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left one comment.

Comment thread content/nginx-one-console/nginx-configs/config-templates/author-templates.md Outdated
@CodeMonkeyF5 CodeMonkeyF5 requested review from JTorreG and syousF5 May 22, 2026 21:01
@CodeMonkeyF5 CodeMonkeyF5 requested a review from syousF5 May 26, 2026 16:38
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-console Issues related to NGINX One Console

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants