diff --git a/source/customizations.rst b/source/customizations.rst index 9246b89e..8b176bce 100644 --- a/source/customizations.rst +++ b/source/customizations.rst @@ -20,15 +20,15 @@ So, for example, if you wished to disable the file browser you would simply change it's directory to 700 so it's unreadable by regular users. When this directory is unreadable by regular users, the functionality -it provides will be disabeled. +it provides will be disabled. .. code-block:: sh sudo chmod 700 /var/www/ood/apps/sys/files -Alternatively, if you wished to limit acess you can do so through group +Alternatively, if you wished to limit access you can do so through group permissions. For example, if you wanted to limit access to the file browser -to only memebers in the Unix group ``staff``, you would simply apply the +to only members in the Unix group ``staff``, you would simply apply the applicable file permission such that anonymous users cannot access the directory while members of the ``staff`` Unix group can. @@ -80,7 +80,7 @@ Because the announcement is rendered via ERB you can do some interesting things, msg: | <% if Time.now < Time.new(2018, 9, 24, 12, 0, 0) %> A **Ruby Partial Downtime** for 4 hours on Monday, September 24 from 8:00am to 12:00pm - will prevent SSH login to Ruby nodes and and Ruby VDI sessions. + will prevent SSH login to Ruby nodes and Ruby VDI sessions. <% end %> .. note:: Warnings about the announcement file being missing may be present in users' nginx logs. Despite the warning the Dashboard will still function normally without those files being present. @@ -105,7 +105,7 @@ To display a MOTD file on the Dashboard ensure that the environment variables `` The ``_erb`` formats support ERB rendering to generate more dynamic messages. .. warning:: - Some MOTD formats like ``rss``, ``markdown`` and ``markdown_erb`` can contain malicous + Some MOTD formats like ``rss``, ``markdown`` and ``markdown_erb`` can contain malicious HTML content. For your safety, by default, the Open OnDemand system will not render HTML. We provide :ref:`a configuration to enable HTML rendering in MOTD ` should you need to render HTML. @@ -797,7 +797,7 @@ Full examples are below: # pin any app with an exact match on the metadata field_of_science of biology - field_of_science: 'biology' - # pin any app with an glob match *bio* on the metadata field_of_science + # pin any app with a glob match *bio* on the metadata field_of_science - field_of_science: '*bio*' @@ -849,7 +849,7 @@ Custom layouts in the dashboard ------------------------------- Administrators can now customize what widgets appear on the dashboard and how they're -layed out on the page. +laid out on the page. In it's simplest form this feature allows for a rearrangement of existing widgets. As of 2.1 the existing widgets are: @@ -1215,7 +1215,7 @@ Grafana support It's possible to display Grafana graphs within the ActiveJobs app when a user expands a given job. -Grafana must be configured to support embedded panels and at this time it is also required to have a anonymous organization. Below are configuration options are needed to support displaying Grafana panels in ActiveJobs. Adjust `org_name` to match whatever organization you wish to be anonymous. +Grafana must be configured to support embedded panels and at this time it is also required to have an anonymous organization. Below are configuration options are needed to support displaying Grafana panels in ActiveJobs. Adjust `org_name` to match whatever organization you wish to be anonymous. .. warning:: diff --git a/source/customizations/main-navigation.inc b/source/customizations/main-navigation.inc index 6c9f2bf5..ac1b746d 100644 --- a/source/customizations/main-navigation.inc +++ b/source/customizations/main-navigation.inc @@ -10,7 +10,7 @@ This section provides the outline of how the navigation bar is generated to begi with, then details the various ways to modify it. Once you understand how the navigation bar is generated automatically, -you can take steps to custimize it as you see fit. +you can take steps to customize it as you see fit. .. _understanding-default-nav-bar: @@ -38,7 +38,7 @@ these manifests files and builds additional dropdown menus (or adds to existing based on the ``category`` field. By default, the system will generate a new dropdown menu for every ``category`` -it encounters. Within each dropdown menu it will add seperators for each +it encounters. Within each dropdown menu it will add separators for each ``subcategory`` it encounters. .. _limit-auto-generated-menu-bars: @@ -63,7 +63,7 @@ use the :ref:`nav_categories configuration property `. this scheme, Open OnDemand 3.0 will not. 3.0 will only support the ``nav_categories`` property. - Here is the `2.0 documentation for controling the navbar`_. + Here is the `2.0 documentation for controlling the navbar`_. Using manifests to create menu items .................................... @@ -139,7 +139,7 @@ configuration would be (without showing any discovered apps). - user - logout -The configuration above would be equvialent to the default navigation bar as described +The configuration above would be equivalent to the default navigation bar as described in :ref:`understanding-default-nav-bar`. As menus are dynamically discovered *from your system*, this documentation can only cover @@ -208,7 +208,7 @@ Here's an example of defining all of them and what that would look like. .. figure:: /images/def-templates-menu.png :align: center - :alt: An image of the navigation bar. From left to right the items are "All Apps" link, "Apps" dropdown menu, "My Interactive Sesssions" link, "Develop" drop down menu, "Help" drop down menu, "Logout" link and 'logged in as ood' text. + :alt: An image of the navigation bar. From left to right the items are "All Apps" link, "Apps" dropdown menu, "My Interactive Sessions" link, "Develop" drop down menu, "Help" drop down menu, "Logout" link and 'logged in as ood' text. .. _menus-based-on-applications: @@ -326,7 +326,7 @@ Menus for custom pages ********************** If you've enabled `custom_pages_guide`_ you can create navigation menus -or single links directly to those pages through the the ``page`` attribute. +or single links directly to those pages through the ``page`` attribute. .. code-block:: yaml diff --git a/source/customizations/support-ticket.inc b/source/customizations/support-ticket.inc index af655222..145253c5 100644 --- a/source/customizations/support-ticket.inc +++ b/source/customizations/support-ticket.inc @@ -6,7 +6,7 @@ Support Tickets The Dashboard now supports sending a support ticket to your institution Help Desk system. The feature uses email as the delivery mechanism, but it could be extended to support others. -To enable this feature, define the settings needed using the the configuration property ``support_ticket``. +To enable this feature, define the settings needed using the configuration property ``support_ticket``. Once this configuration object is defined, the ``Submit Support Ticket`` link will be shown in the ``Help`` navigation menu and in all interactive session cards. @@ -24,9 +24,9 @@ A brief description of the default form fields used in the support ticket form: * **Username:** Logged in user. Username will be added to the support ticket body for reference. * **Email:** Email address to communicate regarding this support ticket. A single email address is supported. -* **CC:** Additional email address to communicate regardig this ticket. A single email address is supported. +* **CC:** Additional email address to communicate regarding this ticket. A single email address is supported. * **Subject:** Brief description of the problem. -* **Attachments:** Add screeshots of the problem to help with debugging and troubleshooting. +* **Attachments:** Add screenshots of the problem to help with debugging and troubleshooting. * **Description:** Detail description of the problem. Configuration @@ -47,8 +47,8 @@ These are the most common configuration properties needed to enable and setup th .. warning:: Use caution when supplying username and password in delivery_settings. These files are readable by - unprivileged users and as such this information can be found by a sophsticated user without privilege - escelation. + unprivileged users and as such this information can be found by a sophisticated user without privilege + escalation. Sample configuration: @@ -70,7 +70,7 @@ Sample configuration: # Optional. # Text added to the page under the support ticket header description: | - My optional description Text for the support ticket feture + My optional description Text for the support ticket feature # email section is required and should always be present. # It configures how the support ticket email is sent diff --git a/source/how-tos/debug/debug-interactive-apps.rst b/source/how-tos/debug/debug-interactive-apps.rst index f2361b7e..3ac6a5bd 100644 --- a/source/how-tos/debug/debug-interactive-apps.rst +++ b/source/how-tos/debug/debug-interactive-apps.rst @@ -6,7 +6,7 @@ Debugging Interactive Apps Log location ------------ -:ref:`Information about interative app log location. ` +:ref:`Information about interactive app log location. ` App completes without being able to connect to it. diff --git a/source/how-tos/monitoring/logging.rst b/source/how-tos/monitoring/logging.rst index 497c167c..89c4120c 100644 --- a/source/how-tos/monitoring/logging.rst +++ b/source/how-tos/monitoring/logging.rst @@ -35,7 +35,7 @@ There are two locations to check depending on what information is needed: :file:`/var/log/httpd/_access.log` -- Where OnDemand will log succsseful logins. +- Where OnDemand will log successful logins. .. warning:: @@ -46,7 +46,7 @@ There are two locations to check depending on what information is needed: The NGINX logs are the output of the user :ref:`PUN `. These logs will capture things relevant to a *particular user* such as: -- Debuggin issues related to job submissions for a user. For example, commands being issued to the scheduler +- Debugging issues related to job submissions for a user. For example, commands being issued to the scheduler (``sbatch``, ``qsub``, etc) can be seen here by searching for ``execve``. - Issues related to PUNs crashing and/or pages not rendering correctly. @@ -72,7 +72,7 @@ information they may need there as well for connections and errors. .. note:: The files will be *owned by the user* and so admins will need to ensure they are either - able to substitue user or escalate to root in order to see these files. + able to substitute user or escalate to root in order to see these files. In general the session data or job submission files for apps across the dashboard, such as the Job Composer, Batch Connect, or Frame-renderer, all start from the root of: diff --git a/source/installation/cluster-config-schema.rst b/source/installation/cluster-config-schema.rst index f1908642..1d2fa332 100644 --- a/source/installation/cluster-config-schema.rst +++ b/source/installation/cluster-config-schema.rst @@ -112,7 +112,7 @@ The job mapping is specific to a cluster's resource manager. bin_overrides: -------------- -`bin_overrides` adds the ability for a site to specify full paths to alternatives to the configured resource manager's client executables. This advanced feature allows a site considerable flexibilty to write wrappers to handle logging, environment or default setting, or use 3rd party API compatible alternative clients without having to alter the resource manager installation. +`bin_overrides` adds the ability for a site to specify full paths to alternatives to the configured resource manager's client executables. This advanced feature allows a site considerable flexibility to write wrappers to handle logging, environment or default setting, or use 3rd party API compatible alternative clients without having to alter the resource manager installation. .. warning :: `bin_overrides` is an advanced feature. OOD relies both on return codes from clients, and on parsing the standard output in order to get information about submitted jobs. Care and testing is recommended. @@ -210,4 +210,4 @@ An example config file in ``ondemand.d/pitzer_01_login.yml``: host: "pitzer-login01.hpc.osu.edu" Again, the thing to note here is we've left off the ``v2.job`` which renders the cluster useable only for logins, i.e. -*no jobs will be scheduleable on this cluster.* \ No newline at end of file +*no jobs will be scheduleable on this cluster.* diff --git a/source/installation/resource-manager/slurm.rst b/source/installation/resource-manager/slurm.rst index 56d8b0c0..0c4de157 100644 --- a/source/installation/resource-manager/slurm.rst +++ b/source/installation/resource-manager/slurm.rst @@ -8,10 +8,10 @@ cluster looks like: .. warning:: Open OnDemand's Slurm support defaults to issuing CLI commands with - the ``--export`` flag set to ``NONE``, when Slurms default is ``ALL``. + the ``--export`` flag set to ``NONE``, when Slurm's default is ``ALL``. This can cause issues with jobs that require ``srun``. - Work arounds are currently to ``export SLURM_EXPORT_ENV=ALL`` + Workarounds are currently to ``export SLURM_EXPORT_ENV=ALL`` in a :ref:`script_wrapper ` before any job scripts run. Alternatively, you can use ``copy_environment`` below with the caveat @@ -48,7 +48,7 @@ cluster .. warning:: Using the ``cluster`` option is discouraged. This is because maintenance - outages on the Slurm database will propogate to Open OnDemand. Instead sites + outages on the Slurm database will propagate to Open OnDemand. Instead sites should use different ``conf`` files for each cluster to limit maintenance outages. bin The path to the Slurm client installation binaries. @@ -67,7 +67,7 @@ bin_overrides - `scancel` copy_environment - Copies the enviornment of the PUN when issuing CLI commands. Default behaviour + Copies the environment of the PUN when issuing CLI commands. Default behaviour for Open OnDemand is to use ``--export=NONE`` flag. Setting this to true will cause Open OnDemand to issue CLI commands with ``--export=ALL``. Though this may cause issues as the PUN's environment is very different than a regular shell session.