DanielLeens opened a new issue, #11274:
URL: https://github.com/apache/seatunnel/issues/11274

   ## Background
   
   Users who build jobs in SeaTunnel Web UI can hit configuration questions 
that are not covered by the current `dev/docs` tree. Two recurring examples are:
   
   - What should be filled in the job `env` block when saving a visual job?
   - What is `custom_parameters` used for in the Web UI, and how does it affect 
the generated SeaTunnel config?
   
   The current documentation mainly covers engine configuration and connector 
configuration, but does not clearly explain these Web UI concepts or common 
validation errors such as `job env can't be empty`.
   
   ## Goal
   
   Add user-facing documentation for SeaTunnel Web UI configuration concepts 
that map to SeaTunnel job config, especially `env` and `custom_parameters`.
   
   ## Suggested scope
   
   Please add or update English and Chinese documentation under the most 
appropriate docs location for SeaTunnel Web / UI usage.
   
   The new content should explain:
   
   1. What the Web UI `env` section maps to in a SeaTunnel job config.
   2. Minimal valid `env` examples for batch and streaming jobs.
   3. Why `job env can't be empty` can appear and how to fix it.
   4. What `custom_parameters` is intended for.
   5. Whether `custom_parameters` are substituted into connector options, 
transform options, or only stored as UI metadata.
   6. A simple end-to-end example showing a visual job and the generated config 
fragments.
   
   ## Acceptance criteria
   
   - The docs explain the Web UI field names in terms a new user can map back 
to SeaTunnel HOCON job config.
   - The docs include at least one valid batch example and one valid streaming 
example.
   - English and Chinese docs are consistent.
   - The behavior is checked against the current Web UI implementation or 
generated configuration path.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to