Skip to content

Commit

Permalink
fix these links
Browse files Browse the repository at this point in the history
  • Loading branch information
johrstrom committed Nov 30, 2023
1 parent 57201b5 commit 307fd00
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions source/how-tos/app-development/interactive/submit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ The configuration file ``submit.yml.erb`` controls the content of the batch
script as well as the submission arguments used when submitting the batch job.
It is located in the root of the application directory.

.. tip::
This page is an introduction to the ``submit.yml.erb``, it's contents
and it's use.

Reference documentation holds :ref:`all configuration items for submit.yml.erb <submit-yml-erb>`.

Assuming we already have a sandbox Interactive App deployed under::

${HOME}/ondemand/dev/my_app
Expand All @@ -28,8 +34,8 @@ The three possible configuration options that can be used in the

.. describe:: batch_connect (Hash)

The configuration describing the batch script content. See
`<submit-yml-erb>` for more details.
The configuration describing the batch script content.
Reference documentation holds :ref:`all configuration items for submit.yml.erb <submit-yml-erb>`.

Example
Use the default basic web server template
Expand All @@ -44,7 +50,8 @@ The three possible configuration options that can be used in the
.. describe:: script (Hash)

The configuration describing the job submission parameters for the batch
script. See `<_submit-script-options>` for more details.
script. Reference documentation holds
:ref:`all configuration items for submit.yml.erb <submit-yml-erb>`.

Example
Set the job's charged account and queue
Expand Down Expand Up @@ -112,21 +119,20 @@ All batch scripts are generated from either the ``basic`` template or the
batch_connect:
template: "vnc"
Aside from the above configuration option, a list of all possible configuration
options for ``batch_connect`` are listed in the reference page `<_submit-yml-erb>`.
Reference documentation holds :ref:`all configuration items for submit.yml.erb <submit-yml-erb>`.

.. note::

The configuration ``template: "vnc"`` comes with more ``batch_connect``
configuration options which can be found under the code documentation for
`<_vnc-bc-options>`.
:ref:`vnc-bc-options`.

Configure Script
````````````````

The ``script`` configuration option defines the batch job submission parameters
(e.g., number of nodes, wall time, queue, ...). The list of all possible
options can be found under the code documentation for `<_submit-script-options>`.
options can be found under the code documentation for :ref:`submit-script-options`.

It is recommended to refrain from using the ``native`` option to best keep your
Interactive App as portable as possible. Although we understand this may not be
Expand Down Expand Up @@ -220,7 +226,7 @@ script it forks off into the background. This can be configured with:
Specify Job Submission Parameters
`````````````````````````````````

Cherry-picking some possible options from `<_submit-script-options>` gives a batch
Cherry-picking some possible options from :ref:`submit-script-options` gives a batch
job built from the basic web server template submitted with the following
parameters:

Expand Down

0 comments on commit 307fd00

Please sign in to comment.