Skip to content

Commit 888daa9

Browse files
committed
[ci skip] Autodoc commit for 8077b23c5346f60eeca942d7f6a43db75c5cfd5b.
1 parent b8a159c commit 888daa9

184 files changed

Lines changed: 5584 additions & 2178 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

latest/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 3b2c736b182793034ba9082095793fd4
3+
config: bd703e07f1af30f688fe9a8035490397
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

latest/_images/workflow.gif

-151 KB
Loading
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. _accessibility:
2+
3+
Accessibility
4+
=============
5+
6+
Introduction
7+
------------
8+
9+
Open OnDemand has undergone several reviews and updates to meet
10+
`WCAG`_ 2.2 guidelines. However, there are a few steps centers need to
11+
take to achieve complete compliance. These steps are documented here along
12+
with areas or certain features that are not complaint.
13+
14+
Accessibility Conformance Report
15+
--------------------------------
16+
17+
Developers have uploaded a VPAT document online on `Open OnDemand's accessibility page`_ which
18+
you may retrieve and review. This document is from the voluntary product assessment
19+
template a registered service mark of the Information Technology Industry Council (ITI).
20+
21+
Additional Configurations Needed
22+
--------------------------------
23+
.. include:: accessibility_settings.inc
24+
25+
Custom pages and Passenger applications
26+
---------------------------------------
27+
28+
Centers that provide additional custom web pages, dashboard widgets, Passenger
29+
applications and so on should take care to meet the `WCAG`_ 2.2 guidelines.
30+
The developers of Open OnDemand can only manage and review the pages that
31+
are shipped in the packages, not any custom pages or Passenger applications
32+
that have been developed by any given center.
33+
34+
.. _Open OnDemand's accessibility page: https://www.openondemand.org/accessibility

latest/_sources/customizations.rst.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,6 @@ Currently only the dashboard uses the colors in the navbar.
178178

179179
.. list-table:: Branding
180180
:header-rows: 1
181-
:stub-columns: 1
182181

183182
* - Feature
184183
- Property
@@ -233,18 +232,17 @@ This will result in a CSS tag added to all dashboard pages with the path: ``/pub
233232
234233
custom_css_files: ["/myfolder/custom-branding.css"]
235234
236-
.. _help_menu_guide:
237-
238235
.. include:: customizations/overriding-partials.inc
239236

237+
.. _help_menu_guide:
238+
240239
Add URLs to Help Menu
241240
---------------------
242241

243242
These URLs can be specified, which will appear in the Help menu and on other locations of the Dashboard. We recommend setting this in ``/etc/ood/config/apps/dashboard/env``.
244243

245244
.. list-table:: Dashboard URLs
246245
:header-rows: 1
247-
:stub-columns: 1
248246

249247
* - Name
250248
- Environment variable
@@ -993,7 +991,6 @@ In each default translation dictionary file the values that are most site-specif
993991

994992
.. list-table:: OnDemand Locale Files
995993
:header-rows: 1
996-
:stub-columns: 1
997994

998995
* - File path
999996
- App
@@ -1026,6 +1023,8 @@ In each default translation dictionary file the values that are most site-specif
10261023

10271024
.. _Yaml spec: https://yaml.org/spec/1.2/spec.html#id2777534
10281025

1026+
.. _change_welcome_html:
1027+
10291028
Change the Dashboard Tagline
10301029
............................
10311030

latest/_sources/how-tos/app-development/interactive/view.rst.txt

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,20 +43,31 @@ the output of the batch connect app.
4343
``view.html.erb`` file. The Dashboard has internal logic in place for
4444
displaying connection information of VNC sessions to the user.
4545

46+
.. _view_session_info:
47+
4648
Session Information
4749
-------------------
4850

4951
A **running** interactive session will generate a connection information file
5052
in the working directory of the corresponding batch job. This information is
51-
then made available to the HTML template ``view.html.erb`` when it is rendered.
52-
The possible connection information attributes are:
53-
54-
host
55-
the hostname of the compute node that the interactive session is running on
56-
port
57-
the port number that the running web server is listening on
58-
password
59-
the password that the web server expects when authenticating the user
53+
then made available to the HTML template ``view.html.erb`` when it is rendered
54+
with two variables, the ``session`` and ``connect`` objects.
55+
56+
**session**
57+
``id``
58+
the unique id assigned to the session
59+
``job_id``
60+
the job id assigned by the scheduler
61+
``created_at``
62+
the time the job was submitted, in Unix epoch time
63+
64+
**connect**
65+
``host``
66+
the hostname of the compute node that the interactive session is running on
67+
``port``
68+
the port number that the running web server is listening on
69+
``password``
70+
the password that the web server expects when authenticating the user
6071

6172
Typically these attributes are used to construct links or forms within the
6273
``view.html.erb`` file. See the various

latest/_sources/how-tos/project-management/project-manager.rst.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ is important to ensure that your directory structure meets these minimum require
9393
#. Any group directory directly below ``OOD_SHARED_PROJECT_PATH`` should have ``rwx`` permissions
9494
for the group
9595

96+
.. _project_templates:
97+
9698
Templates
9799
.........
98100

latest/_sources/index.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ These are institutions who were early adopters or provided HPC resources for dev
8383
:caption: Reference
8484

8585
architecture
86+
accessibility
8687
reference
8788
security
8889
release-notes

latest/_sources/installation.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Installation
66
The OnDemand host machine needs to be setup *similarly* to a login node. This
77
means that it will need:
88

9-
- RedHat/RockyLinux/AlmaLinux 8+ or Ubuntu 22.04-24.04 or Debian 12 or Amazon Linux 2023
9+
- RedHat/RockyLinux/AlmaLinux 8+ or Ubuntu 24.04 & 26.04 or Debian 12 & 13 or Amazon Linux 2023
1010
- the resource manager (e.g., Torque, Slurm, or LSF) client binaries and
1111
libraries used by the batch servers installed
1212
- configuration on both OnDemand node **and batch servers** to be able to

latest/_sources/installation/install-software.rst.txt

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,24 +110,24 @@ Open OnDemand uses these packages, among many others.
110110
111111
sudo dnf install ondemand
112112
113-
.. tab:: Ubuntu 22.04
113+
.. tab:: Ubuntu 24.04
114114

115115
.. code-block:: sh
116116
117117
sudo apt install apt-transport-https ca-certificates
118-
wget -O /tmp/ondemand-release-web_{{ ondemand_version }}.0-jammy_all.deb https://apt.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web_{{ ondemand_version }}.0-jammy_all.deb
119-
sudo apt install /tmp/ondemand-release-web_{{ ondemand_version }}.0-jammy_all.deb
118+
wget -O /tmp/ondemand-release-web_{{ ondemand_version }}.0-noble_all.deb https://apt.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web_{{ ondemand_version }}.0-noble_all.deb
119+
sudo apt install /tmp/ondemand-release-web_{{ ondemand_version }}.0-noble_all.deb
120120
sudo apt update
121121
122122
sudo apt install ondemand
123123
124-
.. tab:: Ubuntu 24.04
124+
.. tab:: Ubuntu 26.04
125125

126126
.. code-block:: sh
127127
128128
sudo apt install apt-transport-https ca-certificates
129-
wget -O /tmp/ondemand-release-web_{{ ondemand_version }}.0-noble_all.deb https://apt.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web_{{ ondemand_version }}.0-noble_all.deb
130-
sudo apt install /tmp/ondemand-release-web_{{ ondemand_version }}.0-noble_all.deb
129+
wget -O /tmp/ondemand-release-web_{{ ondemand_version }}.0-resolute_all.deb https://apt.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web_{{ ondemand_version }}.0-resolute_all.deb
130+
sudo apt install /tmp/ondemand-release-web_{{ ondemand_version }}.0-resolute_all.deb
131131
sudo apt update
132132
133133
sudo apt install ondemand
@@ -143,6 +143,17 @@ Open OnDemand uses these packages, among many others.
143143
144144
sudo apt install ondemand
145145
146+
.. tab:: Debian 13
147+
148+
.. code-block:: sh
149+
150+
sudo apt install apt-transport-https ca-certificates
151+
wget -O /tmp/ondemand-release-web_{{ ondemand_version }}.0-trixie_all.deb https://apt.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web_{{ ondemand_version }}.0-trixie_all.deb
152+
sudo apt install /tmp/ondemand-release-web_{{ ondemand_version }}.0-trixie_all.deb
153+
sudo apt update
154+
155+
sudo apt install ondemand
156+
146157
.. tab:: Amazon Linux 2023
147158

148159
.. code-block:: sh

latest/_sources/reference/files/ondemand-d-ymls.rst.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -290,24 +290,25 @@ Configuration Properties with profile support
290290
291291
dashboard_title: "My Institution"
292292
293+
.. _show_all_apps_link:
293294
.. describe:: show_all_apps_link (Bool, false)
294295

295296
Whether to show the ``All Apps`` link in the navbar.
296297
This links to the Dashboard page showing all system installed applications.
297298

298299
Default
299-
``false``, the ``All Apps`` link will not be shown in the navbar.
300+
``true``, the ``All Apps`` link will be shown in the navbar.
300301

301302
.. code-block:: yaml
302303
303-
show_all_apps_link: false
304+
show_all_apps_link: true
304305
305306
Example
306-
Include the ``All Apps`` link in the navbar.
307+
Do not show the ``All Apps`` link in the navbar.
307308

308309
.. code-block:: yaml
309310
310-
show_all_apps_link: true
311+
show_all_apps_link: false
311312
312313
.. describe:: nav_bar (Array<Object>, [])
313314

0 commit comments

Comments
 (0)