-
William E Warriner authored1a207cd4
README 3.85 KiB
# RC Open OnDemand (OOD) Main Page Communications !!! important Do not give this file (`README`) a `.md` suffix. All files with `.md` are picked up by OOD as announcement banners. This file should not appear as an announcement banner. !!! note Everything in this repo is based on our current version of OOD 1.6. <https://osc.github.io/ood-documentation/release-1.6/customization.html> We will need to review the rules when we upgrade to a newer version of OOD. This repo is to track changes to OOD main page communications. ## Contributing - Please read this README before contributing. - Merge requests are welcome. - One announcement per announcement file. ## Official OOD Docs https://osc.github.io/ood-documentation/release-1.6/customization.html ## Contents In the repo, there are two types of files besides this README file, each of which is described below. 1. `motd` - A single markdown file that defines the OOD main page content. Stands for "Message of the Day". Must not have `.md` suffix. 2. Announcements - Zero or more markdown files. Each file defines one announcement box on the OOD main page. ### `motd` The `motd` file will affect the "Message of the Day" section on the main page of OOD. We have OOD set to `MOTD_FORMAT="markdown"`. So, you must use markdown syntax in `motd`. The content in `motd` appears on the main page of the OOD Dashboard. !!! note The Office Hours and Docs links are very important. They help our community reach us. Please leave them in place. ### Announcements Each announcement file will add a message box appearing at the top of the OOD main page. Put each separate announcement in a separate announcement file. Use markdown syntax and follow the style guide below. Announcements should be posted in the [Docs News Page](https://docs.rc.uab.edu/news/) first. This allows cross-linking from the announcement to the relevant Docs News post. The Docs News Page will generally have more detail. OOD Announcements should be brief and to the point. #### Announcement Style - Each file should have the date it was created and a title. Please use the following format. ``` {creation_date}-announce-{title}.md 2025-07-02-announce-cheaha-os-upgrade.md ``` - Use a level four ATX header for the announcement title: `#### Title` - Add a posted date line at the end: `<br><p style="text-align: right">*Posted: {date}*</p>` - Cross-link to the relevant Docs News post. #### Announcement Example ``` # filename: 2025-05-05-announce-rc-survey.md #### Research Computing Customer Survey We invite you to complete our brief [Research Computing Survey](link) by Friday, May 16 to share your experience and suggestions—it takes less than 5 minutes. <br><p style="text-align: right">*Posted: 2025-05-05*</p> ``` #### YAML Alternative (experimental) Announcement files with extension `.yml` will be processed specially. The file may contain Embedded Ruby (ERB). The ERB is interpreted first, then the resulting YAML is interpreted. Each file must contain the following keys. | YAML key | Description | Note | | -------- | -------------------------------------------- | ----------------------------------------------------------------------- | | type | warning, info, success, or danger | this is the Bootstrap alert style | | msg | string containing markdown formatted message | if this is a blank string (only whitespace), the alert will not display | An example of a a YAML announcement that hides itself after a certain timestamp: ```yaml type: warning 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. <% end %> ```