-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description
The documentation in docs/source/ needs to be updated to address gaps accumulated across versions 2.1.0 through 3.0.8. Changes in the CHANGELOG.md were not reflected in the published docs, resulting in stale YAML examples, references to removed classes, incorrect protocol names, and missing documentation for major features.
Proposed Changes
API Reference Fixes (docs/source/nost_tools_api/)
schemas.rst: Addautopydantic_modeldirectives for 10 new freeze/resume/update schema classes (FreezeCommand,ResumeCommand,FreezeRequest,ResumeRequest,UpdateRequestand their parameter models). Fix "MQTT" references to "AMQP".application.rst: Removautoclassdirective for deletedTimeScaleUpdateclass (removed in 3.0.0). Fix "MQTT" references to "AMQP".simulator.rst: Addautoclassdirectives forMessageObserver,MessageObservable,PropertyChangeCallback,ScenarioTimeIntervalCallback, andWallclockTimeIntervalCallback(added in 2.1.0).index.rst: Update command/status message lists to include new schema classes and callback observers. Fix "MQTT" references to "AMQP".
YAML Configuration Fixes (docs/source/operators_guide/modules/)
example.yml: Full rewrite to match current schema - removedtime_scale_updates, changedmanaged_application(singular) tomanaged_applications(dict format), added missing fields:reconnect_delay,blocked_connection_timeout,queue_max_size,frame_max,socket_timeout,stack_timeout,wallclock_offset_refresh_interval,ntp_host,resume_tolerance,is_scenario_time_step,is_scenario_time_status_step,configuration_parameters, andexecution.applicationssection.yml_file.rst: Update all commented-out YAML examples andliteralincludeline ranges to match the newexample.yml. Add new sections for Application Configuration and Logging Configuration. Fixautopydantic_modelimport paths fromnost_tools.configurationtonost_tools.schemas(the classes are defined inschemas.py). Fix RST heading underline lengths.nost_publisher_consumer_example.rst: Removetime_scale_updates, fixmanaged_applicationtomanaged_applicationsdict format, update.envexample to show three authentication modes, fix import path fromnost_tools.configtonost_tools.configuration.
New Documentation Pages
operators_guide/modules/authentication_modes.rst: Documents the three authentication modes added in v3.0.3 and v3.0.4 - Basic Auth (localhost), Keycloak Service Account, and Keycloak User Account - with YAML and.envexamples for each.resources_library/freeze_resume/index.rst: Documents the distributed freeze/resume/update request system added in v3.0.0, includingrequest_freeze(),request_resume(),request_update()usage, tolerance-based resume, and the request-command message flow.resources_library/file_logging/index.rst: Documents theconfigure_file_logging()method andLoggingConfigmodel added in v2.4.0, with YAML and programmatic configuration examples.
Cross-Reference and Toctree Updates
resources_library/index.rst: Add toctree entries forfreeze_resume/indexandfile_logging/index.operators_guide/modules/amqp.rst: Add toctree entry forauthentication_modes.operators_guide/modules/amqp_keycloak.rst: Add note linking to the new authentication modes page.installation/installation.rst: Update Credentials section to describe the three authentication modes with cross-reference to the auth modes page.resources_library/time_management/index.rst: RemoveTimeScaleUpdatefrom theexecute_test_plancode block and parameter table. Add note explaining that time scale updates are now requested dynamically viarequest_update().release_docs/icd/index.rst: Add staleness admonition noting the ICD was written for v1.0 using MQTT/Solace and directing readers to the current API Reference.
Documentation Gaps Addressed
| Gap | Versions | Resolution |
|---|---|---|
| Freeze/resume/update request system | 3.0.0 | New page + schema directives |
| Authentication modes (basic, service account, user account) | 3.0.3, 3.0.4 | New page + installation updates |
| File logging configuration | 2.4.0 | New page + YAML config section |
| Callback observer classes | 2.1.0 | Added to simulator.rst |
| Tolerance-based resume requests | 3.0.4, 3.0.5 | Covered in freeze/resume page |
| Unmanaged Application configuration | 3.0.5 | New YAML config section |
Stale TimeScaleUpdate references |
Removed in 3.0.0 | Removed from all docs |
Stale managed_application (singular) YAML key |
Changed in 2.0.3 | Updated to managed_applications dict |
| Missing YAML fields across versions | 2.0.1ΓÇô3.0.5 | Added to example.yml and yml_file.rst |
| MQTT protocol references | Changed in 2.0.0 | Fixed to AMQP throughout |
| Outdated ICD (v1.0, MQTT/Solace) | 2.0.0 | Added staleness warning |
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation