Add documentation regarding multi-tenant environment/ecflow commands#395
Merged
Conversation
Introduce a Technical Notes section under docs/tn/ with an orphan index, and add a note documenting the multi-tenant reference environment, a development-only deployment used to exercise the HTTP/HTTPS authentication path end-to-end and to trial the multi-tenant server features. The section is not linked from the main documentation index; each note is reachable only by a direct link.
Add a technical note under docs/tn/ documenting the full ecFlow client/server command set, and link it from the Technical Notes index. It groups the 35 commands into task commands and user commands, and documents for every command its type, C++ class, command-line action(s) and parameters, environment variables, usage, and the native cereal request/reply payloads exchanged on the wire. Each command also carries a Help tab reproducing the verbatim ecflow_client --help output, with a combobox to switch between actions on multi-action commands. The goal is to collect implementation details, rather than provide user facing information, thus it is not linked from the main documentation index.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #395 +/- ##
========================================
Coverage 52.08% 52.08%
========================================
Files 1247 1247
Lines 101710 101710
Branches 15136 15136
========================================
+ Hits 52971 52974 +3
+ Misses 48739 48736 -3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
See commit messages.
Contributor Declaration
By opening this pull request, I affirm the following:
🌦️ >> Documentation << 🌦️
https://sites.ecmwf.int/docs/dev-section/ecflow/pull-requests/PR-395