From 6aaf9e2e40576c93081c6e8778f1f0128ea47912 Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Tue, 21 Jan 2025 10:20:23 -0500 Subject: [PATCH] More spelling 3 (#1075) correct more spelling errors and add more words to this list. --- .../install-keycloak.rst | 34 ++++++------ .../enabling-development-mode.rst | 2 +- source/reference/files/submit-yml-erb.rst | 4 +- .../files/submit-yml/basic-bc-options.rst | 2 +- source/reference/files/submit-yml/script.rst | 8 +-- .../files/submit-yml/vnc-bc-options.rst | 48 ++++++++--------- .../submit-yml/vnc-container-bc-options.rst | 10 ++-- source/spelling_wordlist.txt | 5 ++ .../tutorials-dashboard-apps/dashboard.rst | 54 +++++++++---------- .../tutorials-dashboard-apps/shell-app.rst | 20 +++---- .../add-custom-queue/global-static-list.rst | 4 +- .../add-custom-queue/local-static-list.rst | 2 +- .../add-jupyter/copy-app.rst | 14 ++--- .../add-jupyter/deploy.rst | 2 +- .../add-matlab/copy-app.rst | 12 ++--- .../add-matlab/deploy.rst | 2 +- .../add-matlab/edit-form-js.rst | 4 +- .../add-matlab/edit-form-yml.rst | 2 +- .../add-matlab/edit-script-sh.rst | 8 +-- .../add-matlab/software-requirements.rst | 2 +- .../add-rstudio/copy-app.rst | 10 ++-- .../add-rstudio/deploy.rst | 2 +- .../add-rstudio/setup-singularity.rst | 2 +- .../k8s-jupyter.rst | 14 ++--- .../k8s-like-hpc-jupyter.rst | 10 ++-- .../troubleshooting.rst | 2 +- source/tutorials/tutorials-passenger-apps.rst | 2 +- .../deploy-to-production.inc | 2 +- .../nodejs-starter-app.rst | 4 +- .../ruby-starter-app.rst | 12 ++--- 30 files changed, 152 insertions(+), 147 deletions(-) diff --git a/source/authentication/tutorial-oidc-keycloak-rhel7/install-keycloak.rst b/source/authentication/tutorial-oidc-keycloak-rhel7/install-keycloak.rst index d2c22232f..bebd4b120 100644 --- a/source/authentication/tutorial-oidc-keycloak-rhel7/install-keycloak.rst +++ b/source/authentication/tutorial-oidc-keycloak-rhel7/install-keycloak.rst @@ -6,7 +6,7 @@ Install Keycloak We will install and launch Keycloak server behind Apache. Login to the host where you will install Keycloak. In this tutorial, we are -installing Keycloak on the same host as OnDemand, which is webdev07.hpc.osc.edu. +installing Keycloak on the same host as OnDemand, which is ``webdev07.hpc.osc.edu``. .. warning:: @@ -25,7 +25,7 @@ Initial Installation Steps sudo tar xzf keycloak-9.0.0.tar.gz -#. Add keycloak user and change ownership of files +#. Add ``keycloak`` user and change ownership of files .. code-block:: sh @@ -38,13 +38,13 @@ Initial Installation Steps sudo install -d -o keycloak -g keycloak /var/lib/keycloak - This makes a home directory, which is needed when running API calls as keycloak user. Finally we set proper permissions: + This makes a home directory, which is needed when running API calls as ``keycloak`` user. Finally we set proper permissions: .. code-block:: sh sudo chown keycloak: -R keycloak-9.0.0 -#. Restrict access to keycloak-9.0.0/standalone, which will contain +#. Restrict access to ``keycloak-9.0.0/standalone``, which will contain sensitive data for the Keycloak server .. code-block:: sh @@ -60,7 +60,7 @@ Initial Installation Steps sudo yum install java-1.8.0-openjdk-devel -#. Added 'admin' to '/opt/keycloak-9.0.0/standalone/configuration/keycloak-add-user.json', (re)start server to load user. +#. Added 'admin' to ``/opt/keycloak-9.0.0/standalone/configuration/keycloak-add-user.json``, (re)start server to load user. If you are not already there: @@ -87,22 +87,22 @@ Initial Installation Steps sudo -u keycloak ./bin/jboss-cli.sh 'embed-server,/socket-binding-group=standard-sockets/socket-binding=proxy-https:add(port=443)' sudo -u keycloak ./bin/jboss-cli.sh 'embed-server,/subsystem=undertow/server=default-server/http-listener=default:write-attribute(name=redirect-socket,value=proxy-https)' - Or you can use a config.cli file that contains these commands. We have + Or you can use a ``config.cli`` file that contains these commands. We have provided an example file to make use of in this gist, with blocks commented - out so you can wget the file, edit as appropriate, and run via: + out so you can ``wget`` the file, edit as appropriate, and run via: .. code-block:: sh sudo -u keycloak ./bin/jboss-cli.sh --file=config.cli - Where the config.cli looks like: + Where the ``config.cli`` looks like: .. literalinclude:: example-keycloak-jboss-config.cli Start Keycloak Server ------------------------- -#. Create keycloak.service to start and stop the server: +#. Create ``keycloak.service`` to start and stop the server: .. code-block:: sh @@ -125,7 +125,7 @@ Start Keycloak Server EOF - Then start keycloak: + Then start ``keycloak``: .. code-block:: sh @@ -148,7 +148,7 @@ Start Keycloak Server Place Apache in front of Keycloak --------------------------------- -#. Define apache config to proxy keycloak requests +#. Define apache configuration to proxy Keycloak requests. .. note:: @@ -164,7 +164,7 @@ Place Apache in front of Keycloak Add ``/opt/rh/httpd24/root/etc/httpd/conf.d/ood-keycloak.conf``, making changes for the appropriate SSL certificate locations. Notice we are proxying ``https://ondemand-idpdev.hpc.osc.edu`` to ``http://localhost:8080`` which is the default - port the Keycloak webserver runs as. + port the Keycloak web-server runs as. .. literalinclude:: example-keycloak-apache.conf @@ -185,13 +185,13 @@ Differences if installing Keycloak on separate host When installing Keycloak on a separate host, the difference between this tutorial would be: -#. throughout the rest of the tutorial replace ``https://ondemand-idpdev.hpc.osc.edu`` with the keycloak host +#. throughout the rest of the tutorial replace ``https://ondemand-idpdev.hpc.osc.edu`` with the Keycloak host #. possibly use Apache 2.4 default distribution instead of software collections, - meaning that configuration would be at /etc/httpd/conf.d/ instead of - /opt/rh/httpd24/root/etc/httpd/conf.d/ and starting the + meaning that configuration would be at ``/etc/httpd/conf.d/`` instead of + ``/opt/rh/httpd24/root/etc/httpd/conf.d/`` and starting the service is likely ``sudo systemctl start httpd`` instead of ``sudo systemctl start httpd24-httpd`` -For example, if Keycloak were installed on a separate host idp.hpc.edu then the -Apache config might look like: +For example, if Keycloak were installed on a separate host ``idp.hpc.edu`` then the +Apache configuration might look like: .. literalinclude:: example-keycloak-apache-separate-host.conf diff --git a/source/how-tos/app-development/enabling-development-mode.rst b/source/how-tos/app-development/enabling-development-mode.rst index 11af72ee2..256b7d8b4 100644 --- a/source/how-tos/app-development/enabling-development-mode.rst +++ b/source/how-tos/app-development/enabling-development-mode.rst @@ -43,7 +43,7 @@ Enable in OnDemand v1.3: Here are example steps to enable a user ``efranz``, assuming ``efranz``'s home directory is at ``/home/efranz``: #. Create ``dev`` directory ``/home/efranz/ondemand/dev`` where ``efranz``'s development apps will go (or ask ``efranz`` to do that). -#. Have ``efranz`` access the Dashboard, and they will see the Develop drop-down. (if this doesn't happen, ) +#. Have ``efranz`` access the Dashboard, and they will see the Develop drop-down. (if this does not happen) .. note:: diff --git a/source/reference/files/submit-yml-erb.rst b/source/reference/files/submit-yml-erb.rst index caf820c34..7a277dbde 100644 --- a/source/reference/files/submit-yml-erb.rst +++ b/source/reference/files/submit-yml-erb.rst @@ -1,7 +1,7 @@ .. _submit-yml-erb: -submit.yml.erb -============== +``submit.yml.erb`` +================== This is the file that is submitted to a batch connect job. It is comprised of a ``script`` and a ``batch_connect`` attribute. The ``batch_connect`` diff --git a/source/reference/files/submit-yml/basic-bc-options.rst b/source/reference/files/submit-yml/basic-bc-options.rst index 9832409c5..334ba7886 100644 --- a/source/reference/files/submit-yml/basic-bc-options.rst +++ b/source/reference/files/submit-yml/basic-bc-options.rst @@ -368,7 +368,7 @@ Basic Batch Connect Options the file all the connection data will be written to Default - a file named 'connection.yml' + A file named ``connection.yml``. .. code-block:: yaml diff --git a/source/reference/files/submit-yml/script.rst b/source/reference/files/submit-yml/script.rst index 64b2ad063..99afbf23a 100644 --- a/source/reference/files/submit-yml/script.rst +++ b/source/reference/files/submit-yml/script.rst @@ -12,7 +12,7 @@ script. be available to override in batch connect applications. For example, ``workdir`` is set by the OnDemand system in batch - connect applications, and cannot be overidden. + connect applications, and cannot be overridden. .. tip:: If you're using the ``ood_core`` gem (where all these are defined and used) @@ -101,17 +101,17 @@ Note the use of ERB templates throughout these examples. .. describe:: rerunnable (Boolean, nil) - Indicate whether the job is rerunnable. + Indicate whether the job is re-runnable. Default - Empty, it is not rerunnable. + Empty, it is not re-runnable. .. code-block:: yaml rerunnable: nil Example - The job is rerunnable. + The job is re-runnable. .. code-block:: yaml diff --git a/source/reference/files/submit-yml/vnc-bc-options.rst b/source/reference/files/submit-yml/vnc-bc-options.rst index b1ded2501..fb1591fa5 100644 --- a/source/reference/files/submit-yml/vnc-bc-options.rst +++ b/source/reference/files/submit-yml/vnc-bc-options.rst @@ -32,17 +32,17 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be .. describe:: websockfiy_cmd (String, "/opt/websockify/run") - the command to start websockify + the command to start ``websockify``. Default - the '/opt/websockify/run' command + The ``/opt/websockify/run`` command. .. code-block:: yaml websockfiy_cmd: "/opt/websockify/run" Example - the '/usr/bin/websockify' command + The ``/usr/bin/websockify`` command. .. code-block:: yaml @@ -50,17 +50,17 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be .. describe:: vnc_passwd (String, "vnc.passwd") - the file vncserver will read for a password + the file ``vncserver`` will read for a password Default - a file named 'vnc.passwd' + a file named ``vnc.passwd``. .. code-block:: yaml vnc_passwd: "vnc.passwd" Example - a file named 'my-other-vnc.passwd' + a file named ``my-other-vnc.passwd``. .. code-block:: yaml @@ -68,7 +68,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be .. describe:: vnc_args (String, "") - vnc arguments to use instead of the specific options + VNC arguments to use instead of the specific options ``name``, ``geometry``, ``dpi``, ``fonts``, ``idle`` and ``extra_args``. @@ -80,7 +80,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be vnc_args: "" Example - only specify the xstartup option + Only specify the ``xstartup`` option. .. code-block:: yaml @@ -91,14 +91,14 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be the desktop name Default - do not specify name, vncserver defaults to ``host:display# (username)`` + do not specify name, ``vncserver`` defaults to ``host:display# (username)`` .. code-block:: yaml name: "" Example - boot vncserver with ``-name ood-$USER-$DISPLAY`` argument + boot ``vncserver`` with ``-name ood-$USER-$DISPLAY`` argument. .. code-block:: yaml @@ -109,14 +109,14 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be the geometry size of the VNC desktop Default - do not specify geometry, turbovnc defaults to ``1240x900`` + do not specify geometry, TurboVNC defaults to ``1240x900`` .. code-block:: yaml geometry: "" Example - boot vncserver with ``-geometry 1920x1080`` argument + boot ``vncserver`` with ``-geometry 1920x1080`` argument. .. code-block:: yaml @@ -134,7 +134,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be dpi: "" Example - boot vncserver with ``-dpi 96`` argument + boot ``vncserver`` with ``-dpi 96`` argument .. code-block:: yaml @@ -145,14 +145,14 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be the font path for X11 fonts Default - do not specify -fp option + do not specify ``-fp`` option .. code-block:: yaml fonts: "" Example - boot vncserver with ``-fp unix/:7100`` argument + boot ``vncserver`` with the ``-fp unix/:7100`` argument. .. code-block:: yaml @@ -160,17 +160,17 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be .. describe:: idle (String, "") - the idle timeout setting for the vncserver + the idle timeout setting for the ``vncserver``. Default - do not specify -idletimeout option + do not specify ``-idletimeout`` option .. code-block:: yaml idle: "" Example - boot vncserver with ``-idletimeout 3600`` argument + boot ``vncserver`` with ``-idletimeout 3600`` argument .. code-block:: yaml @@ -178,7 +178,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be .. describe:: extra_args (String, "") - any extra arguments to pass into vncserver + any extra arguments to pass into ``vncserver``. Default do not specify extra arguments @@ -188,7 +188,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be idle: "" Example - set the color depth of the vncserver to 32, in addition to any + set the color depth of the ``vncserver`` to 32, in addition to any other specific argument given above .. code-block:: yaml @@ -206,7 +206,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be the connection parameters that will be written to the ``conn_file`` Default - 'host', 'port', 'password', 'spassword', 'display' and 'websocket' + ``host``, ``port``, ``password``, ``spassword``, ``display`` and ``websocket``. .. code-block:: yaml @@ -230,18 +230,18 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be .. describe:: websockify_heartbeat_seconds (Integer, 30) - The duration in seconds websockify will wait to send heartbeats + The duration in seconds ``websockify`` will wait to send heartbeats to the client. Default - Websockify will send heartbeats every 30 seconds. + ``websockify`` will send heartbeats every 30 seconds. .. code-block:: yaml websockify_heartbeat_seconds: 30 Example - Have websockfiy send heartbeats every 10 seconds. + Have ``websockfiy`` send heartbeats every 10 seconds. .. code-block:: yaml diff --git a/source/reference/files/submit-yml/vnc-container-bc-options.rst b/source/reference/files/submit-yml/vnc-container-bc-options.rst index e784d72ad..0d8f67ab4 100644 --- a/source/reference/files/submit-yml/vnc-container-bc-options.rst +++ b/source/reference/files/submit-yml/vnc-container-bc-options.rst @@ -23,7 +23,7 @@ All the options in :ref:`vnc-bc-options` apply in addition to what's listed belo The full path to the container image you wish to boot. Default - Load the vnc_container.sif image. + Load the ``vnc_container.sif`` image. .. code-block:: yaml @@ -38,7 +38,7 @@ All the options in :ref:`vnc-bc-options` apply in addition to what's listed belo .. describe:: container_bindpath (String, "") - A comma seperated list of mountpoints you wish to bind into the container. + A comma separated list of mount-points you wish to bind into the container. Default Do not bind any paths into the container. @@ -48,7 +48,7 @@ All the options in :ref:`vnc-bc-options` apply in addition to what's listed belo container_bindpath: "" Example - Bind /etc, /dev and /usr into the container. + Bind ``/etc``, ``/dev`` and ``/usr`` into the container. .. code-block:: yaml @@ -117,9 +117,9 @@ You can use this as an example to start and update as required. .. note:: - Note that we're installing turbovnc and websockify *inside* + Note that we're installing ``turbovnc`` and ``websockify`` *inside* the container. This is important as all processes will run - inside the contianer and not on the host. + inside the container and not on the host. You can still install these on the host machine, but they will need to be mounted inside the container as the processes are diff --git a/source/spelling_wordlist.txt b/source/spelling_wordlist.txt index 23dab96cd..faac15bf6 100644 --- a/source/spelling_wordlist.txt +++ b/source/spelling_wordlist.txt @@ -113,6 +113,11 @@ Nvidia URI favicon pre +runnable +TurboVNC +lookups +sudo +grey Aday Wisniewski diff --git a/source/tutorials/tutorials-dashboard-apps/dashboard.rst b/source/tutorials/tutorials-dashboard-apps/dashboard.rst index 754ea6549..f3d06dd02 100644 --- a/source/tutorials/tutorials-dashboard-apps/dashboard.rst +++ b/source/tutorials/tutorials-dashboard-apps/dashboard.rst @@ -19,12 +19,12 @@ Also, it is recommended to set this to your local app environment so that ``bund the gems on the system, as unlike ``npm`` which starts builds locally by default, ``bundler`` attempts system installs by default. -Create a Dev Dashboard ----------------------- -#. ``clone`` the OOD repo into: ``cd ~/ondemand/misc`` then ``git clone git@github.com:OSC/ondemand.git`` +Create a Development Dashboard +------------------------------ +#. ``clone`` the OOD repository into: ``cd ~/ondemand/misc`` then ``git clone git@github.com:OSC/ondemand.git`` #. Work out of the ``dev`` directory/space: ``cd ~/ondemand/dev/``. -#. Symlink to the ``dashboard`` app in the cloned repo: ``ln -s ../misc/ondemand/apps/dashboard/dashboard/ dashboard`` -#. Make a branch and to begin word on your dev dashboard: ``git checkout -b dev_work`` +#. Symlink to the ``dashboard`` app in the cloned repository: ``ln -s ../misc/ondemand/apps/dashboard/dashboard/ dashboard`` +#. Make a branch and to begin word on your development dashboard: ``git checkout -b dev_work`` #. Rebuild the ood dashboard app: ``bin/setup``. #. Navigate to the Sandbox and launch your ``dashboard`` app to use the ``dev_work``. @@ -33,7 +33,7 @@ you see ``/pun/sys/dashboard/`` but instead ``/pun/dev/dashboard/``. Add ``.env.local`` File ----------------------- -Now that we have a our dev dashboard running, a good first step is to next ensure it +Now that we have a our development dashboard running, a good first step is to next ensure it looks different from the production dashboard. This will help ensure not ending up in the wrong tab, using ``sys/dashboard`` instead of ``dev/dashboard``, and possibly causing confusion. @@ -45,32 +45,32 @@ Use an editor or IDE and do the following: touch .env.local vim .env.local -The idea here is to make sure the dev dashboard *looks* different so we don't have to check that ``url`` in the +The idea here is to make sure the development dashboard *looks* different so we don't have to check that ``url`` in the browser to know which dashboard we are in. -Inside the ``.env.local`` we can add an environment variable to change the color of the dev dashboard like so: +Inside the ``.env.local`` we can add an environment variable to change the color of the development dashboard like so: .. code-block:: sh # .env.local file OOD_BRAND_BG_COLOR='grey' -Now click the ``Develop`` dropdown menu on the upper right corner and click ``Restart Web Server``. After a few moments -you should now see the dashboard with a grey background in the banner. This will help to distinguish your dev +Now click the ``Develop`` drop-down menu on the upper right corner and click ``Restart Web Server``. After a few moments +you should now see the dashboard with a grey background in the banner. This will help to distinguish your development environment from the production. .. figure:: ../../images/develop_dashboard_grey_background.png :align: center - Different banner color for the dev dashboard + Different banner color for the development dashboard -Set Dev Configuration Directory -------------------------------- -Our dev dashboard is still using the same configuration files as the system dashboard, but we can change this. +Set Development Configuration Directory +--------------------------------------- +Our development dashboard is still using the same configuration files as the system dashboard, but we can change this. -Go back into ``.env.local`` and set a new path for *the dev dashboard to pick up its own +Go back into ``.env.local`` and set a new path for *the development dashboard to pick up its own configurations* using the ``OOD_CONFIG_D_DIRECTORY`` environment variable like so: .. code-block:: sh @@ -80,13 +80,13 @@ configurations* using the ``OOD_CONFIG_D_DIRECTORY`` environment variable like s We need to *restart the PUN when we add or change environment variables* with ``bin/setup``. -Add Dev Configurations ----------------------- +Add Development Configurations +------------------------------ Now, we can begin to set our own configurations in our new ``ondemand.d`` directory for -the dev dashboard and see the changes. Let's add some configs to our dev dashboard to get +the development dashboard and see the changes. Let's add some configurations to our development dashboard to get an idea what can be done and play with the layout. -We will add ``pinned_apps`` to our dev dashboard as an example to see how this works. +We will add ``pinned_apps`` to our development dashboard as an example to see how this works. Create a file in the ``~/ondemand/dev/dashboard/config/ondemand.d/`` directory named ``ondemand.yml`` then open the file and add the following: @@ -98,23 +98,23 @@ open the file and add the following: pinned_apps_menu_length: 4 pinned_apps_group_by: category -Assuming youre restarted the PUN when you set the new config directory above, you *should* be able to simply +Assuming you have restarted the PUN when you set the new configuration directory above, you *should* be able to simply refresh the browser and see the new pinned apps layout take effect. If not though, simply restart the PUN as usual to force the changes. .. figure:: ../../images/develop_dashboard_pinned_apps.png :align: center - Dev dashboard with its own pinned apps configuration + Development dashboard with its own pinned apps configuration Now, we can begin to add other configurations to this new ``ondemand.yml`` and keep restarting the PUN to see our changes. This is a great way to test out new features, or play with any features you may be interested in with OOD before -making the changes in production or spinning up a whole dev environment with a VM. +making the changes in production or spinning up a whole development environment with a VM. At this point you have all the pieces needed to use the :ref:`customizations` page and play with those changes -in your dev dashboard. +in your development dashboard. But, what if we want to add something to Open OnDemand? @@ -123,18 +123,18 @@ Develop OOD in OOD With all the above in place, you can also begin to add features and functionality to OOD in this development setting to then see how this will actually run and work. -Suppose you see a feature being worked on in the OOD repo on the branch ``new_feature``. How could you pull +Suppose you see a feature being worked on in the OOD repository on the branch ``new_feature``. How could you pull this work down and see its current state while also trying to build it out? -First, launch the ``shell`` and go into your dev ``dashboard`` root then: +First, launch the ``shell`` and go into your development ``dashboard`` root then: #. ``git pull`` #. ``git checkout new_feature`` #. ``bin/setup`` -After the build you now have the feature ready to be worked right there in your dev dashboard. +After the build you now have the feature ready to be worked right there in your development dashboard. -Go ahead and enter you Sandbox and launch the dev dashboard. What you are in once that is done is the current +Go ahead and enter you Sandbox and launch the development dashboard. What you are in once that is done is the current state the feature is in. If you are not making any changes to the configurations, as the steps above mostly do, then each change to the code diff --git a/source/tutorials/tutorials-dashboard-apps/shell-app.rst b/source/tutorials/tutorials-dashboard-apps/shell-app.rst index e36c0ca9a..f76244df3 100644 --- a/source/tutorials/tutorials-dashboard-apps/shell-app.rst +++ b/source/tutorials/tutorials-dashboard-apps/shell-app.rst @@ -4,16 +4,16 @@ Developing the Shell App ======================== The ``shell`` app is significantly different from the dashboard app. It is purely a ``node.js`` app. -This means that we only need to use ``npm`` to build and do dev work. +This means that we only need to use ``npm`` to build and do development work. -Create a Dev Shell ------------------- -#. ``clone`` the OOD repo into: ``cd ~/ondemand/misc`` then ``git clone git@github.com:OSC/ondemand.git`` +Create a Development Shell +-------------------------- +#. ``clone`` the OOD repository into: ``cd ~/ondemand/misc`` then ``git clone git@github.com:OSC/ondemand.git`` #. Work out of the ``dev`` directory/space: ``cd ~/ondemand/dev/``. -#. Symlink to the ``shell`` app in the cloned repo: ``ln -s ../misc/ondemand/apps/dashboard/shell/ shell`` -#. Make a branch and to begin word on your dev dashboard: ``git checkout -b dev_work`` +#. Symlink to the ``shell`` app in the cloned repository: ``ln -s ../misc/ondemand/apps/dashboard/shell/ shell`` +#. Make a branch and to begin word on your development dashboard: ``git checkout -b dev_work`` #. Rebuild the ``shell`` app: ``bin/setup``. -#. Navigate to the Sandbox and launch your dev ``shell`` app to use the ``dev_work`` branch. +#. Navigate to the Sandbox and launch your development ``shell`` app to use the ``dev_work`` branch. Notice the ``url`` for this app. No longer do you see ``*/sys/shell`` but instead ``*/dev/shell``. @@ -33,8 +33,8 @@ Then for the **shell app** from a login terminal run: And then step into that symlinked directory and run: #. ``bin/setup`` -If you go start this app from sandbox you'll notice a different url than before, -showing you are in a dev shell: ``pun/dev/shell-1.8`` +If you go start this app from sandbox you'll notice a different URL than before, +showing you are in a development shell: ``pun/dev/shell-1.8`` Issues and Errors ................. @@ -46,5 +46,5 @@ be when you run ``bin/setup``. Develop the Shell ----------------- -At this point we have a working dev ``shell`` and can start to make changes to this code and issue rebuilds +At this point we have a working development ``shell`` and can start to make changes to this code and issue rebuilds for ``npm`` with ``bin/setup`` when needed. \ No newline at end of file diff --git a/source/tutorials/tutorials-interactive-apps/add-custom-queue/global-static-list.rst b/source/tutorials/tutorials-interactive-apps/add-custom-queue/global-static-list.rst index 8d8056644..9e56b91b4 100644 --- a/source/tutorials/tutorials-interactive-apps/add-custom-queue/global-static-list.rst +++ b/source/tutorials/tutorials-interactive-apps/add-custom-queue/global-static-list.rst @@ -51,7 +51,7 @@ desires) with a list of available queues/partitions: .. warning:: - Be sure to click "Restart Web Server" on the Dashboard everytime you edit + Be sure to click "Restart Web Server" on the Dashboard every time you edit the Cluster Configuration file for changes to take effect within the app. .. _app-development-tutorials-interactive-apps-add-custom-queue-global-static-list-add-custom-attribute: @@ -188,7 +188,7 @@ options read from the corresponding cluster configuration file. The user will see a list of options: "Volvo", "Ford", and "Toyota" to choose from in the HTML form, but the backend will process a value of - either "volvo", "ford", or "toyota" depending on what the user chose. + either ``volvo``, ``ford``, or ``toyota`` depending on what the user chose. .. _app-development-tutorials-interactive-apps-add-custom-queue-global-static-list-handle-custom-attribute: diff --git a/source/tutorials/tutorials-interactive-apps/add-custom-queue/local-static-list.rst b/source/tutorials/tutorials-interactive-apps/add-custom-queue/local-static-list.rst index 532c7b9cc..f6877e7fb 100644 --- a/source/tutorials/tutorials-interactive-apps/add-custom-queue/local-static-list.rst +++ b/source/tutorials/tutorials-interactive-apps/add-custom-queue/local-static-list.rst @@ -107,7 +107,7 @@ We want to **replace** the ``bc_queue`` form attribute with a custom HTML The user will see a list of options: "Volvo", "Ford", and "Toyota" to choose from in the HTML form, but the backend will process a value of - either "volvo", "ford", or "toyota" depending on what the user chose. + either ``volvo``, ``ford``, or ``toyota`` depending on what the user chose. .. _app-development-tutorials-interactive-apps-add-custom-queue-local-static-list-handle-custom-attribute: diff --git a/source/tutorials/tutorials-interactive-apps/add-jupyter/copy-app.rst b/source/tutorials/tutorials-interactive-apps/add-jupyter/copy-app.rst index 71e3091d8..51a5812dd 100644 --- a/source/tutorials/tutorials-interactive-apps/add-jupyter/copy-app.rst +++ b/source/tutorials/tutorials-interactive-apps/add-jupyter/copy-app.rst @@ -15,7 +15,7 @@ We will begin by first copying over a pre-built example Jupyter app. - introduce you to app development and make you an Interactive App developer #. We do all of our app development in our Open OnDemand sandbox directory. First we need - to allow our user to create sandbox apps by creating a symlink to point to our homedir: + to allow our user to create sandbox apps by creating a symlink to point to our home directory: .. code:: sh @@ -30,7 +30,7 @@ We will begin by first copying over a pre-built example Jupyter app. system apps These are apps that all users have access to and appear in the - Dashboard dropdown menus. They are installed on the local disk with + Dashboard drop-down menus. They are installed on the local disk with very permissive file permissions. Located on the file system under:: @@ -74,10 +74,10 @@ We will begin by first copying over a pre-built example Jupyter app. https://ondemand.my_center.edu/ - You should now see a *Develop* dropdown menu option in the top right of the + You should now see a *Develop* drop-down menu option in the top right of the dashboard. -#. Open up the *Develop* menu dropdown and click the link *My Sandbox Apps +#. Open up the *Develop* menu drop-down and click the link *My Sandbox Apps (Development)*. #. You will navigate to a page that lists all of your sandbox apps (all the @@ -93,9 +93,9 @@ We will begin by first copying over a pre-built example Jupyter app. this is the directory that the app will be cloned to in our sandbox directory (must be unique) Git remote - this is the link to the git repo that is cloned + this is the link to the git repository that is cloned Create a new Git Project from this? - whether we want to create a new app from this git repo + whether we want to create a new app from this git repository For now fill in the form with the following values: @@ -122,5 +122,5 @@ We will begin by first copying over a pre-built example Jupyter app. Launch button in the developer views. This `will be fixed in 1.5 `_. A work around is to manually enter the URL to the batch connect app. In this - Jupyter tutorial, if the directory name is "jupyter" then the URL will be + Jupyter tutorial, if the directory name is ``jupyter`` then the URL will be ``/pun/sys/dashboard/batch_connect/dev/jupyter``. diff --git a/source/tutorials/tutorials-interactive-apps/add-jupyter/deploy.rst b/source/tutorials/tutorials-interactive-apps/add-jupyter/deploy.rst index a1b44f9db..a6b2ecba6 100644 --- a/source/tutorials/tutorials-interactive-apps/add-jupyter/deploy.rst +++ b/source/tutorials/tutorials-interactive-apps/add-jupyter/deploy.rst @@ -24,6 +24,6 @@ deploy it as a System App. sudo cp -r jupyter /var/www/ood/apps/sys/. #. In your browser navigate to the OnDemand URL and confirm you see the new app - in the *Interactive Apps* dropdown on the dashboard. + in the *Interactive Apps* drop-down on the dashboard. https://ondemand.my_center.edu/ diff --git a/source/tutorials/tutorials-interactive-apps/add-matlab/copy-app.rst b/source/tutorials/tutorials-interactive-apps/add-matlab/copy-app.rst index 72cba8b5f..fe5d3d5bf 100644 --- a/source/tutorials/tutorials-interactive-apps/add-matlab/copy-app.rst +++ b/source/tutorials/tutorials-interactive-apps/add-matlab/copy-app.rst @@ -28,7 +28,7 @@ We will begin by first copying over a pre-built MATLAB app in production at OSC. system apps These are apps that all users have access to and appear in the - Dashboard dropdown menus. They are installed on the local disk with + Dashboard drop-down menus. They are installed on the local disk with very permissive file permissions. Located on the file system under:: @@ -72,10 +72,10 @@ We will begin by first copying over a pre-built MATLAB app in production at OSC. https://ondemand.my_center.edu/ - You should now see a *Develop* dropdown menu option in the top right of the + You should now see a *Develop* drop-down menu option in the top right of the dashboard. -#. Open up the *Develop* menu dropdown and click the link *My Sandbox Apps +#. Open up the *Develop* menu drop-down and click the link *My Sandbox Apps (Development)*. #. You will navigate to a page that lists all of your sandbox apps (all the @@ -91,9 +91,9 @@ We will begin by first copying over a pre-built MATLAB app in production at OSC. this is the directory that the app will be cloned to in our sandbox directory (must be unique) Git remote - this is the link to the git repo that is cloned + this is the link to the git repository that is cloned Create a new Git Project from this? - whether we want to create a new app from this git repo + whether we want to create a new app from this git repository For now fill in the form with the following values: @@ -120,5 +120,5 @@ We will begin by first copying over a pre-built MATLAB app in production at OSC. Launch button in the developer views. This `was fixed in 1.5 `_. A work around is to manually enter the URL to the batch connect app. In this - MATLAB tutorial, if the directory name is "bc_my_center_matlab" then the URL will be + MATLAB tutorial, if the directory name is ``bc_my_center_matlab`` then the URL will be ``/pun/sys/dashboard/batch_connect/dev/bc_my_center_matlab``. diff --git a/source/tutorials/tutorials-interactive-apps/add-matlab/deploy.rst b/source/tutorials/tutorials-interactive-apps/add-matlab/deploy.rst index c03c75370..1844f616f 100644 --- a/source/tutorials/tutorials-interactive-apps/add-matlab/deploy.rst +++ b/source/tutorials/tutorials-interactive-apps/add-matlab/deploy.rst @@ -24,6 +24,6 @@ deploy it as a System App. sudo cp -r bc_my_center_matlab /var/www/ood/apps/sys/. #. In your browser navigate to the OnDemand URL and confirm you see the new app - in the *Interactive Apps* dropdown on the dashboard. + in the *Interactive Apps* drop-down on the dashboard. https://ondemand.my_center.edu/ diff --git a/source/tutorials/tutorials-interactive-apps/add-matlab/edit-form-js.rst b/source/tutorials/tutorials-interactive-apps/add-matlab/edit-form-js.rst index 7477334e6..a380c911f 100644 --- a/source/tutorials/tutorials-interactive-apps/add-matlab/edit-form-js.rst +++ b/source/tutorials/tutorials-interactive-apps/add-matlab/edit-form-js.rst @@ -1,7 +1,7 @@ .. _app-development-tutorials-interactive-apps-add-matlab-edit-form-js: -Edit Form.js -============ +Edit ``form.js`` +================ OnDemand supports dynamic interactive forms using a file named ``~/ondemand/dev/bc_my_center_matlab/form.js``. This file is free-form; anything that can be done with client-side JavaScript may be done in this file. OSC has used this file to: diff --git a/source/tutorials/tutorials-interactive-apps/add-matlab/edit-form-yml.rst b/source/tutorials/tutorials-interactive-apps/add-matlab/edit-form-yml.rst index 9c514cf6d..032b9ec21 100644 --- a/source/tutorials/tutorials-interactive-apps/add-matlab/edit-form-yml.rst +++ b/source/tutorials/tutorials-interactive-apps/add-matlab/edit-form-yml.rst @@ -135,7 +135,7 @@ The main responsibility of the ``form.yml`` file (:ref:`app-development-interact step: 1 id: 'num_cores' - ``bc_num_slots`` is hardcoded to 1 and is not user editable because OSC does not support MPI work from the Batch Connect app. The value for ``bc_vnc_resolution`` should be copied verbatim. ``bc_account`` is the charge account for the batch work. + ``bc_num_slots`` is hard-coded to 1 and is not user editable because OSC does not support MPI work from the Batch Connect app. The value for ``bc_vnc_resolution`` should be copied verbatim. ``bc_account`` is the charge account for the batch work. .. code-block:: yaml diff --git a/source/tutorials/tutorials-interactive-apps/add-matlab/edit-script-sh.rst b/source/tutorials/tutorials-interactive-apps/add-matlab/edit-script-sh.rst index 60e89ac62..66d828dec 100644 --- a/source/tutorials/tutorials-interactive-apps/add-matlab/edit-script-sh.rst +++ b/source/tutorials/tutorials-interactive-apps/add-matlab/edit-script-sh.rst @@ -5,7 +5,7 @@ Edit Launch Script Here we will look at the script that actually launches MATLAB ``~/ondemand/dev/bc_my_center_matlab/template/script.sh.erb``. -By now you should have selected your prefered window manager. Examples of using XFCE, Mate, and Fluxbox: +By now you should have selected your preferred window manager. Examples of using XFCE, Mate, and Fluxbox: - :ref:`app-development-tutorials-interactive-apps-add-matlab-wm-xfce` - :ref:`app-development-tutorials-interactive-apps-add-matlab-wm-mate` @@ -47,7 +47,7 @@ Invoking MATLAB without a Window Manager Use XFCE for the Window Manager ------------------------------- -XFCE is OSC's prefered desktop environment for launching VNC applications. The code for starting XFCE in the background looks like this (see highlighted lines 1-20): +XFCE is OSC's preferred desktop environment for launching VNC applications. The code for starting XFCE in the background looks like this (see highlighted lines 1-20): .. code-block:: shell :emphasize-lines: 1-20 @@ -138,7 +138,7 @@ The code for starting Mate in the background looks like this (see highlighted li .. note:: - `According to the developers`_ the correct pronunciation of Mate is "mah-tay" like the drink, and not matey like pirates, or mate like a friend. + `According to the developers`_ the correct pronunciation of Mate is ``mah-tay`` like the drink, and not matey like pirates, or mate like a friend. .. _app-development-tutorials-interactive-apps-add-matlab-wm-fluxbox: @@ -147,7 +147,7 @@ Use Fluxbox for the Window Manager .. warning:: - Fluxbox has been replaced by XFCE as OSC's prefered window manager / desktop environment. + Fluxbox has been replaced by XFCE as OSC's preferred window manager / desktop environment. The code for starting Fluxbox in the background looks like this (see highlighted lines 1-36): diff --git a/source/tutorials/tutorials-interactive-apps/add-matlab/software-requirements.rst b/source/tutorials/tutorials-interactive-apps/add-matlab/software-requirements.rst index 1b893be84..fcda7b25d 100644 --- a/source/tutorials/tutorials-interactive-apps/add-matlab/software-requirements.rst +++ b/source/tutorials/tutorials-interactive-apps/add-matlab/software-requirements.rst @@ -32,7 +32,7 @@ node: .. note:: We believe that the desktop based approach is superior, but are aware that - other sites may prefer an implemenation that does not require a full desktop + other sites may prefer an implementation that does not require a full desktop be installed. `Fluxbox`_ is a window manager that has been used in place of XFCE/Mate. An example of OSC's deprecated `Fluxbox based implementation`_ is available on Github. diff --git a/source/tutorials/tutorials-interactive-apps/add-rstudio/copy-app.rst b/source/tutorials/tutorials-interactive-apps/add-rstudio/copy-app.rst index 2cda30e26..66c02d199 100644 --- a/source/tutorials/tutorials-interactive-apps/add-rstudio/copy-app.rst +++ b/source/tutorials/tutorials-interactive-apps/add-rstudio/copy-app.rst @@ -28,7 +28,7 @@ We will begin by first copying over a pre-built example RStudio app. system apps These are apps that all users have access to and appear in the - Dashboard dropdown menus. They are installed on the local disk with + Dashboard drop-down menus. They are installed on the local disk with very permissive file permissions. Located on the file system under:: @@ -72,10 +72,10 @@ We will begin by first copying over a pre-built example RStudio app. https://ondemand.my_center.edu/ - You should now see a *Develop* dropdown menu option in the top right of the + You should now see a *Develop* drop-down menu option in the top right of the dashboard. -#. Open up the *Develop* menu dropdown and click the link *My Sandbox Apps +#. Open up the *Develop* menu drop-down and click the link *My Sandbox Apps (Development)*. #. You will navigate to a page that lists all of your sandbox apps (all the @@ -91,9 +91,9 @@ We will begin by first copying over a pre-built example RStudio app. this is the directory that the app will be cloned to in our sandbox directory (must be unique) Git remote - this is the link to the git repo that is cloned + this is the link to the git repository that is cloned Create a new Git Project from this? - whether we want to create a new app from this git repo + whether we want to create a new app from this git repository For now fill in the form with the following values: diff --git a/source/tutorials/tutorials-interactive-apps/add-rstudio/deploy.rst b/source/tutorials/tutorials-interactive-apps/add-rstudio/deploy.rst index c7b21d0d1..28df02f7c 100644 --- a/source/tutorials/tutorials-interactive-apps/add-rstudio/deploy.rst +++ b/source/tutorials/tutorials-interactive-apps/add-rstudio/deploy.rst @@ -24,6 +24,6 @@ deploy it as a System App. sudo cp -r bc_example_rstudio /var/www/ood/apps/sys/. #. In your browser navigate to the OnDemand URL and confirm you see the new app - in the *Interactive Apps* dropdown on the dashboard. + in the *Interactive Apps* drop-down on the dashboard. https://ondemand.my_center.edu/ diff --git a/source/tutorials/tutorials-interactive-apps/add-rstudio/setup-singularity.rst b/source/tutorials/tutorials-interactive-apps/add-rstudio/setup-singularity.rst index f1239f686..e131887d3 100644 --- a/source/tutorials/tutorials-interactive-apps/add-rstudio/setup-singularity.rst +++ b/source/tutorials/tutorials-interactive-apps/add-rstudio/setup-singularity.rst @@ -23,7 +23,7 @@ Alternatively, Build The Singularity Image Running a build is trivial but does require sudo access to the build host. -Where ``Singularity`` is the file that defines the image. The image is just the base CentOS 7 packages plus a run script. This simplicity is because the actual executables and libraries must be bound and mounted into the container/guest at runtime from the host. By bind-mounting executables and libaries from the host system we are able to swap RStudio versions at launch time without having to update the Singuarlity image. +Where ``Singularity`` is the file that defines the image. The image is just the base CentOS 7 packages plus a run script. This simplicity is because the actual executables and libraries must be bound and mounted into the container/guest at runtime from the host. By bind-mounting executables and libraries from the host system we are able to swap RStudio versions at launch time without having to update the Singularity image. Likewise the ``runscript`` defined in the image uses the host ``$PATH`` which is propagated into the guest's environment as ``$USER_PATH``. diff --git a/source/tutorials/tutorials-interactive-apps/k8s-jupyter.rst b/source/tutorials/tutorials-interactive-apps/k8s-jupyter.rst index 7ef0e0f45..f298ae2a4 100644 --- a/source/tutorials/tutorials-interactive-apps/k8s-jupyter.rst +++ b/source/tutorials/tutorials-interactive-apps/k8s-jupyter.rst @@ -13,7 +13,7 @@ other tutorials like :ref:`app-development-tutorials-interactive-apps-add-jupyte We're going to be looking at the `bc k8s jupyter`_ app which you can fork, clone -and modify for your site. This page also holds the `submit yml in full`_ for reference. +and modify for your site. This page also holds the `submit.yml in full`_ for reference. Refer to :ref:`interactive K8s Jupyter using HPC-like containers ` for details on running Jupyter on Kubernetes with containers that behave more like traditional @@ -94,7 +94,7 @@ configmap --------- A `Kubernetes configmap`_ is a way to apply configurations to a container. -In this example, we're using a configmap to generate the config file for +In this example, we're using a configmap to generate the configuration file for Jupyter. We'll see later how we use init containers to update it, but let's see how we initialize it. @@ -127,7 +127,7 @@ the files they work on. This example mounts the home directory, but could mount any project or scratch space just the same. When mounting a host directory ``host_type`` must always be Directory. -This example shows how to mount host directories and nfs storage locations. +This example shows how to mount host directories and NFS storage locations. .. code-block:: yaml @@ -172,15 +172,15 @@ You must specify a ``name``, an ``image`` and the ``command`` to be run. Let's walk through these init containers and what they're doing. -``init-secret`` does just that. It initialzies a `Kubernetes secret`_. +``init-secret`` does just that. It initializes a `Kubernetes secret`_. ``add-passwd-to-cfg`` then reads that secret and creates a salt and -sha1 of this secret (these are needed specifically for Jupyter). Lastly +``sha1`` of this secret (these are needed specifically for Jupyter). Lastly it adds a single line to our configmap, which is the ``c.NotebookApp.password``. ``add-hostport-to-cfg`` does something similar, reading the host and port of the pod and sets the ``c.NotebookApp.base_url`` of the same configmap. -submit yml in full ------------------- +``submit.yml`` in full +---------------------- .. code-block:: yaml diff --git a/source/tutorials/tutorials-interactive-apps/k8s-like-hpc-jupyter.rst b/source/tutorials/tutorials-interactive-apps/k8s-like-hpc-jupyter.rst index 4af936ccb..1d7c0db21 100644 --- a/source/tutorials/tutorials-interactive-apps/k8s-like-hpc-jupyter.rst +++ b/source/tutorials/tutorials-interactive-apps/k8s-like-hpc-jupyter.rst @@ -4,17 +4,17 @@ Add a Jupyter App on a Kubernetes Cluster that behaves like HPC compute ======================================================================= This tutorial will walk you through creating an interactive Jupyter app that -your users will use to launch a `Jupyter Notebook Server`_ in a kubernetes cluster. +your users will use to launch a `Jupyter Notebook Server`_ in a Kubernetes cluster. The container will behave much like a HPC compute node. This has the benefit that a single app can serve both traditional HPC as well as Kubernetes. It assumes you have a working understanding of app development already. The purpose of -this document is to describe how to write apps specifically for a kubernetes cluster, +this document is to describe how to write apps specifically for a Kubernetes cluster, so it skips a lot of important details about app development that may be found in other tutorials like :ref:`app-development-tutorials-interactive-apps-add-jupyter`. We're going to be looking at the `bc osc jupyter`_ app which is OSC's production Jupyter app. You can fork, clone -and modify for your site. This page also holds the `submit yml in full`_ for reference. +and modify for your site. This page also holds the `submit.yml in full`_ for reference. Refer to :ref:`the interactive K8s Jupyter app ` for additional details on items defined in ``submit.yml.erb`` as well as a more traditional container approach. @@ -176,8 +176,8 @@ Additional mounts are needed to make the pod behave like a HPC compute node. Fol destination_path: <%= apps_path %> -submit yml in full ------------------- +``submit.yml`` in full +---------------------- .. code-block:: yaml diff --git a/source/tutorials/tutorials-interactive-apps/troubleshooting.rst b/source/tutorials/tutorials-interactive-apps/troubleshooting.rst index b90fdf580..9bce45b74 100644 --- a/source/tutorials/tutorials-interactive-apps/troubleshooting.rst +++ b/source/tutorials/tutorials-interactive-apps/troubleshooting.rst @@ -22,7 +22,7 @@ A remedy for MATLAB throwing Java errors when its window is resized, moved, or d Job finishes instantly because, desktop app backgrounds itself ************************************************************** -Many apps are convenient in that their launch command blocks instead of backgrounding itself. By blocking the process our script is prevented from ending immediately, which in turn would prevent the user from accomplishing anything useful. Some GUI applications like Stata put themselves into the background. For apps like Stata it is necessary to perform the blocking ourselves: +Many apps are convenient in that their launch command blocks instead of going into the background. By blocking the process our script is prevented from ending immediately, which in turn would prevent the user from accomplishing anything useful. Some GUI applications like Stata put themselves into the background. For apps like Stata it is necessary to perform the blocking ourselves: .. code-block:: shell diff --git a/source/tutorials/tutorials-passenger-apps.rst b/source/tutorials/tutorials-passenger-apps.rst index e5c80897d..98f25ebca 100644 --- a/source/tutorials/tutorials-passenger-apps.rst +++ b/source/tutorials/tutorials-passenger-apps.rst @@ -3,7 +3,7 @@ Tutorials: Passenger Apps ========================= -A Passenger App is any Rack-based Ruby app, WSGI-based Python app, or Node.js app that has a “startup file” following `the convention `__ that Phusion Passenger Web Application Server instances use to start the process. OnDemand uses the `NGINX Integration mode `__ for Passenger, where NGINX and Passenger and individual web app processes all communicate using UNIX domain sockets. +A Passenger App is any Rack-based Ruby app, WSGI-based Python app, or NodeJs app that has a “startup file” following `the convention `__ that Phusion Passenger Web Application Server instances use to start the process. OnDemand uses the `NGINX Integration mode `__ for Passenger, where NGINX and Passenger and individual web app processes all communicate using UNIX domain sockets. At the bottom of the page is a list of tutorials for developing Passenger apps for OnDemand. diff --git a/source/tutorials/tutorials-passenger-apps/deploy-to-production.inc b/source/tutorials/tutorials-passenger-apps/deploy-to-production.inc index 2463ec0b2..d1b3966f0 100644 --- a/source/tutorials/tutorials-passenger-apps/deploy-to-production.inc +++ b/source/tutorials/tutorials-passenger-apps/deploy-to-production.inc @@ -30,7 +30,7 @@ Steps: # if there is an external remote associated with this, push to that git push origin master -#. As the admin, ``sudo copy`` or ``git clone`` this repo to production +#. As the admin, ``sudo copy`` or ``git clone`` this repository to production. .. code-block:: sh diff --git a/source/tutorials/tutorials-passenger-apps/nodejs-starter-app.rst b/source/tutorials/tutorials-passenger-apps/nodejs-starter-app.rst index 372970232..a2fc066e9 100644 --- a/source/tutorials/tutorials-passenger-apps/nodejs-starter-app.rst +++ b/source/tutorials/tutorials-passenger-apps/nodejs-starter-app.rst @@ -43,8 +43,8 @@ Issue these commands to add and install the package. While this example uses `Express`_, you can choose any `NodeJs`_ web framework available. -Add and edit app.js -------------------- +Add and edit ``app.js`` +----------------------- Now we need the ``app.js`` file that's the entrypoint for this application. After creating this file, we've provided this starter content for you add diff --git a/source/tutorials/tutorials-passenger-apps/ruby-starter-app.rst b/source/tutorials/tutorials-passenger-apps/ruby-starter-app.rst index 2b1af3ab5..9597025e7 100644 --- a/source/tutorials/tutorials-passenger-apps/ruby-starter-app.rst +++ b/source/tutorials/tutorials-passenger-apps/ruby-starter-app.rst @@ -6,8 +6,8 @@ Starter Ruby Application This document walks through creating a hello world application in Ruby with the `Sinatra`_ web framework. -config.ru for Sinatra ---------------------- +``config.ru`` for Sinatra +------------------------- The first thing we need for OnDemand to recognize this directory is a ``config.ru`` file. For `Sinatra`_ this is the ``config.ru`` that you need. @@ -19,8 +19,8 @@ For `Sinatra`_ this is the ``config.ru`` that you need. require_relative 'app' run App -config.ru for Ruby on Rails ---------------------------- +``config.ru`` for Ruby on Rails +------------------------------- This document does not cover `Ruby on Rails`_, but this ``config.ru`` is given nonetheless for readers interested @@ -61,8 +61,8 @@ into ``vendor/bundle``. Issue these commands to do that. bundle install -Write the app.rb file ---------------------- +Write the ``app.rb`` file +------------------------- Still, the app will not boot at this point. The ``config.ru`` is looking to load the ``app.rb`` file which does not exist yet.