From 9d5785bcfad2cef7ab96b29ee90b332863c995b7 Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Wed, 21 Feb 2024 15:17:01 -0500 Subject: [PATCH 1/8] Update _site.yml --- _site.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/_site.yml b/_site.yml index 02cf05a..7df24cd 100644 --- a/_site.yml +++ b/_site.yml @@ -3,18 +3,18 @@ output_dir: '.' navbar: title: OTTR Web left: - - text: Home + - text: 0. Home href: index.html icon: fa-home - - text: Setup + - text: 1. Setup href: setup.html - - text: Hosting + - text: 2. Hosting href: hosting.html - text: Editing href: editing.html - - text: Style + - text: 3. Style href: style.html - - text: Git Actions + - text: 4. Git Actions href: git_actions.html - text: Docker href: docker.html From b14da68a14625f77922d4d07a5460fe32f7ff20d Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Wed, 28 Feb 2024 14:23:05 -0500 Subject: [PATCH 2/8] Update _site.yml --- _site.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_site.yml b/_site.yml index 7df24cd..4b6fb7b 100644 --- a/_site.yml +++ b/_site.yml @@ -3,7 +3,7 @@ output_dir: '.' navbar: title: OTTR Web left: - - text: 0. Home + - text: "" href: index.html icon: fa-home - text: 1. Setup From 5f0f5772d26a15ffdc72364dcee9eafa956e2dc4 Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Wed, 28 Feb 2024 14:24:00 -0500 Subject: [PATCH 3/8] Delete docker.Rmd --- docker.Rmd | 58 ------------------------------------------------------ 1 file changed, 58 deletions(-) delete mode 100644 docker.Rmd diff --git a/docker.Rmd b/docker.Rmd deleted file mode 100644 index 425789a..0000000 --- a/docker.Rmd +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "Docker" -output: html_document ---- - -You might decide to use another package for your website. - -If you do so and the rendering does not appear to work like usual, this is because that package is not set up in the Docker image that the website template uses to render the files using GitHub Actions. - - -## An Example - -For example, you might want to add an emoji to your website using the [`emoji` package](https://cran.r-project.org/web/packages/emoji/emoji.pdf). - -Note that if you wanted to add an emoji,you could simply copy and paste one from this [website](https://gist.github.com/rxaviers/7360908) and it would work. Like so: 😃 - -However, we will use this as a simple example to show why you might want to update the Docker image. - - - - -Let's say you added the following code to your R Markdown document for one of the website pages: - -```{r, fig.align='center', fig.alt= "Page modification", echo = FALSE, out.width="30%"} -knitr::include_graphics("resources/images/emoji.png") -``` -This would result in the following rendering issues: - -```{r, fig.align='center', fig.alt= "Page modification", echo = FALSE, out.width="70%"} -knitr::include_graphics("resources/images/render_fail.png") -``` - -With this error: - -```{r, fig.align='center', fig.alt= "Page modification", echo = FALSE, out.width="70%"} -knitr::include_graphics("resources/images/render_error.png") -``` - -So how can we fix this? - -You could make a new Docker image that includes the `emoji` package. - -## Customizing Docker - -If you need to have the rendering of your website done by a customized Docker image, you can [follow these instructions to start your own new docker image](https://www.ottrproject.org/customize-docker.html#Starting_a_new_Docker_image). - -In summary, you'll need to: - -1. Create a new Dockerfile that begins with: - -``` -FROM jhudsl/course_template:main -``` -So that the OTTR required items are incorporated into your new Docker image. - -2. After you successfully build this new docker image, you need to push it to Dockerhub so it can be pulled by the OTTR Github actions. - -3. Then, in your `config_automation.yml` file, you need to change the `rendering-docker-image:` spec to be the new docker image's name. From 309d7092b579ccccaac5c0d9310cf3134a4ddfde Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Wed, 28 Feb 2024 14:24:17 -0500 Subject: [PATCH 4/8] Delete docker.html --- docker.html | 374 ---------------------------------------------------- 1 file changed, 374 deletions(-) delete mode 100644 docker.html diff --git a/docker.html b/docker.html deleted file mode 100644 index 0c70edd..0000000 --- a/docker.html +++ /dev/null @@ -1,374 +0,0 @@ - - - - - - - - - - - - - -Docker - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - -

You might decide to use another package for your website.

-

If you do so and the rendering does not appear to work like usual, this is because that package is not set up in the Docker image that the website template uses to render the files using GitHub Actions.

-
-

An Example

-

For example, you might want to add an emoji to your website using the emoji package.

-

Note that if you wanted to add an emoji,you could simply copy and paste one from this website and it would work. Like so: 😃

-

However, we will use this as a simple example to show why you might want to update the Docker image.

-

Let’s say you added the following code to your R Markdown document for one of the website pages:

-

Page modification This would result in the following rendering issues:

-

Page modification

-

With this error:

-

Page modification

-

So how can we fix this?

-

You could make a new Docker image that includes the emoji package.

-
-
-

Customizing Docker

-

If you need to have the rendering of your website done by a customized Docker image, you can follow these instructions to start your own new docker image.

-

In summary, you’ll need to:

-
    -
  1. Create a new Dockerfile that begins with:
    2. -
-
FROM jhudsl/course_template:main
-

So that the OTTR required items are incorporated into your new Docker image.

-
    -

  1. After you successfully build this new docker image, you need to push it to Dockerhub so it can be pulled by the OTTR Github actions.

    2. -

  2. Then, in your config_automation.yml file, you need to change the rendering-docker-image: spec to be the new docker image’s name.

    3. -
-
- - - - -
- - - - - - - - - - - - - - - From 4404e3ee4d3e7f764b6adebea7c9acbe9afac74f Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Wed, 28 Feb 2024 14:25:11 -0500 Subject: [PATCH 5/8] Update _site.yml --- _site.yml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/_site.yml b/_site.yml index 4b6fb7b..ee16daa 100644 --- a/_site.yml +++ b/_site.yml @@ -16,11 +16,8 @@ navbar: href: style.html - text: 4. Git Actions href: git_actions.html - - text: Docker - href: docker.html - - text: Contact - href: contact.html - icon: fa-envelope + - text: More ottr docs + href: https://www.ottrproject.org/ output: From d06a2e4cae07344d65eccd20deda01b01af5da37 Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Wed, 28 Feb 2024 14:26:14 -0500 Subject: [PATCH 6/8] Update dictionary.txt --- resources/dictionary.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/resources/dictionary.txt b/resources/dictionary.txt index 1fe7812..c3dd255 100644 --- a/resources/dictionary.txt +++ b/resources/dictionary.txt @@ -16,3 +16,8 @@ Rmd subdir th www +automations +Bootstap +glyphicons +repo +RStudio From cc05a53fca9cd53ea699bcad2fc914a89ba06708 Mon Sep 17 00:00:00 2001 From: Candace Savonen Date: Wed, 28 Feb 2024 15:00:29 -0500 Subject: [PATCH 7/8] update so docs/ is where output is --- .github/.DS_Store | Bin 6148 -> 6148 bytes .github/workflows/pull_request.yml | 4 +- .github/workflows/render-site.yml | 9 +- _site.yml | 2 +- docs/.DS_Store | Bin 0 -> 6148 bytes docs/LICENSE | 21 + docs/config_automation.yml | 24 + contact.html => docs/contact.html | 65 +- editing.html => docs/editing.html | 108 +- git_actions.html => docs/git_actions.html | 127 +- hosting.html => docs/hosting.html | 98 +- index.html => docs/index.html | 75 +- docs/resources/.DS_Store | Bin 0 -> 8196 bytes docs/resources/dictionary.txt | 23 + docs/resources/header.html | 2 + docs/resources/ignore-urls.txt | 1 + docs/resources/images/.DS_Store | Bin 0 -> 6148 bytes docs/resources/images/actions.png | Bin 0 -> 55843 bytes docs/resources/images/add_rule.png | Bin 0 -> 57097 bytes docs/resources/images/blue.png | Bin 0 -> 45374 bytes docs/resources/images/branch_rule.png | Bin 0 -> 184004 bytes docs/resources/images/branches.png | Bin 0 -> 102730 bytes docs/resources/images/checks.png | Bin 0 -> 80964 bytes docs/resources/images/checks2.png | Bin 0 -> 55361 bytes docs/resources/images/classic_tokens.png | Bin 0 -> 51586 bytes docs/resources/images/create-repo.png | Bin 0 -> 482042 bytes docs/resources/images/developer_settings.png | Bin 0 -> 290489 bytes docs/resources/images/emoji.png | Bin 0 -> 8506 bytes docs/resources/images/example_image.png | Bin 0 -> 11546 bytes docs/resources/images/favicon.ico | Bin 0 -> 15406 bytes docs/resources/images/general.png | Bin 0 -> 46238 bytes docs/resources/images/generate_classic.png | Bin 0 -> 140922 bytes docs/resources/images/gh_pat_set_up.png | Bin 0 -> 160299 bytes docs/resources/images/icons.png | Bin 0 -> 95657 bytes docs/resources/images/main_branch.png | Bin 0 -> 54860 bytes docs/resources/images/more_icons.png | Bin 0 -> 77239 bytes docs/resources/images/more_icons_result.png | Bin 0 -> 14957 bytes docs/resources/images/navbar.png | Bin 0 -> 94375 bytes docs/resources/images/page_modification.png | Bin 0 -> 95457 bytes docs/resources/images/pages.png | Bin 0 -> 100361 bytes docs/resources/images/render_error.png | Bin 0 -> 60442 bytes docs/resources/images/render_fail.png | Bin 0 -> 74369 bytes docs/resources/images/render_fail2.png | Bin 0 -> 74837 bytes docs/resources/images/render_fail_details.png | Bin 0 -> 115210 bytes docs/resources/images/repo_action_token.png | Bin 0 -> 252914 bytes docs/resources/images/set_up_token.png | Bin 0 -> 204251 bytes docs/resources/images/setting_gh_pat.png | Bin 0 -> 61686 bytes docs/resources/images/settings.png | Bin 0 -> 36567 bytes docs/resources/images/spelling.png | Bin 0 -> 35153 bytes docs/resources/images/theme.png | Bin 0 -> 95283 bytes docs/resources/images/title.png | Bin 0 -> 95352 bytes docs/resources/images/url_check.png | Bin 0 -> 88547 bytes docs/resources/images/urls.png | Bin 0 -> 44518 bytes docs/resources/images/usersettings.png | Bin 0 -> 84111 bytes docs/resources/images/website_setup.png | Bin 0 -> 323835 bytes docs/resources/images/workflows.png | Bin 0 -> 193492 bytes setup.html => docs/setup.html | 160 +- .../bootstrap-3.3.5/css/bootstrap-theme.css | 0 .../css/bootstrap-theme.css.map | 0 .../css/bootstrap-theme.min.css | 0 .../bootstrap-3.3.5/css/bootstrap.css | 0 .../bootstrap-3.3.5/css/bootstrap.css.map | 0 .../bootstrap-3.3.5/css/bootstrap.min.css | 0 .../bootstrap-3.3.5/css/cerulean.min.css | 0 .../bootstrap-3.3.5/css/cosmo.min.css | 0 .../bootstrap-3.3.5/css/darkly.min.css | 0 .../bootstrap-3.3.5/css/flatly.min.css | 0 .../bootstrap-3.3.5/css/fonts/Lato.ttf | Bin .../bootstrap-3.3.5/css/fonts/LatoBold.ttf | Bin .../bootstrap-3.3.5/css/fonts/LatoItalic.ttf | Bin .../bootstrap-3.3.5/css/fonts/NewsCycle.ttf | Bin .../css/fonts/NewsCycleBold.ttf | Bin .../bootstrap-3.3.5/css/fonts/OpenSans.ttf | Bin .../css/fonts/OpenSansBold.ttf | Bin .../css/fonts/OpenSansBoldItalic.ttf | Bin .../css/fonts/OpenSansItalic.ttf | Bin .../css/fonts/OpenSansLight.ttf | Bin .../css/fonts/OpenSansLightItalic.ttf | Bin .../bootstrap-3.3.5/css/fonts/Raleway.ttf | Bin .../bootstrap-3.3.5/css/fonts/RalewayBold.ttf | Bin .../bootstrap-3.3.5/css/fonts/Roboto.ttf | Bin .../bootstrap-3.3.5/css/fonts/RobotoBold.ttf | Bin .../bootstrap-3.3.5/css/fonts/RobotoLight.ttf | Bin .../css/fonts/RobotoMedium.ttf | Bin .../css/fonts/SourceSansPro.ttf | Bin .../css/fonts/SourceSansProBold.ttf | Bin .../css/fonts/SourceSansProItalic.ttf | Bin .../css/fonts/SourceSansProLight.ttf | Bin .../bootstrap-3.3.5/css/fonts/Ubuntu.ttf | Bin .../bootstrap-3.3.5/css/journal.min.css | 0 .../bootstrap-3.3.5/css/lumen.min.css | 0 .../bootstrap-3.3.5/css/paper.min.css | 0 .../bootstrap-3.3.5/css/readable.min.css | 0 .../bootstrap-3.3.5/css/sandstone.min.css | 0 .../bootstrap-3.3.5/css/simplex.min.css | 0 .../bootstrap-3.3.5/css/spacelab.min.css | 0 .../bootstrap-3.3.5/css/united.min.css | 0 .../bootstrap-3.3.5/css/yeti.min.css | 0 .../fonts/glyphicons-halflings-regular.eot | Bin .../fonts/glyphicons-halflings-regular.svg | 0 .../fonts/glyphicons-halflings-regular.ttf | Bin .../fonts/glyphicons-halflings-regular.woff | Bin .../fonts/glyphicons-halflings-regular.woff2 | Bin .../bootstrap-3.3.5/js/bootstrap.js | 0 .../bootstrap-3.3.5/js/bootstrap.min.js | 0 .../site_libs}/bootstrap-3.3.5/js/npm.js | 0 .../bootstrap-3.3.5/shim/html5shiv.min.js | 0 .../bootstrap-3.3.5/shim/respond.min.js | 0 .../crosstalk-1.1.0.1/css/crosstalk.css | 0 .../crosstalk-1.1.0.1/js/crosstalk.js | 0 .../crosstalk-1.1.0.1/js/crosstalk.js.map | 0 .../crosstalk-1.1.0.1/js/crosstalk.min.js | 0 .../crosstalk-1.1.0.1/js/crosstalk.min.js.map | 0 .../datatables-binding-0.15/datatables.js | 0 .../datatables-crosstalk.css | 0 .../css/jquery.dataTables.extra.css | 0 .../css/jquery.dataTables.min.css | 0 .../js/jquery.dataTables.min.js | 0 .../site_libs}/font-awesome-5.1.0/css/all.css | 0 .../font-awesome-5.1.0/css/v4-shims.css | 0 .../webfonts/fa-brands-400.eot | Bin .../webfonts/fa-brands-400.svg | 0 .../webfonts/fa-brands-400.ttf | Bin .../webfonts/fa-brands-400.woff | Bin .../webfonts/fa-brands-400.woff2 | Bin .../webfonts/fa-regular-400.eot | Bin .../webfonts/fa-regular-400.svg | 0 .../webfonts/fa-regular-400.ttf | Bin .../webfonts/fa-regular-400.woff | Bin .../webfonts/fa-regular-400.woff2 | Bin .../webfonts/fa-solid-900.eot | Bin .../webfonts/fa-solid-900.svg | 0 .../webfonts/fa-solid-900.ttf | Bin .../webfonts/fa-solid-900.woff | Bin .../webfonts/fa-solid-900.woff2 | Bin docs/site_libs/font-awesome-6.4.2/css/all.css | 7968 +++++++++++++++++ .../font-awesome-6.4.2/css/all.min.css | 9 + .../font-awesome-6.4.2/css/v4-shims.css | 2194 +++++ .../font-awesome-6.4.2/css/v4-shims.min.css | 6 + .../webfonts/fa-brands-400.ttf | Bin 0 -> 189684 bytes .../webfonts/fa-brands-400.woff2 | Bin 0 -> 109808 bytes .../webfonts/fa-regular-400.ttf | Bin 0 -> 63348 bytes .../webfonts/fa-regular-400.woff2 | Bin 0 -> 24488 bytes .../webfonts/fa-solid-900.ttf | Bin 0 -> 394668 bytes .../webfonts/fa-solid-900.woff2 | Bin 0 -> 150020 bytes .../webfonts/fa-v4compatibility.ttf | Bin 0 -> 10172 bytes .../webfonts/fa-v4compatibility.woff2 | Bin 0 -> 4568 bytes .../header-attrs-2.10/header-attrs.js | 0 .../header-attrs-2.11/header-attrs.js | 0 .../header-attrs-2.25/header-attrs.js | 12 + .../site_libs}/highlightjs-9.12.0/default.css | 0 .../highlightjs-9.12.0/highlight.js | 0 .../highlightjs-9.12.0/textmate.css | 0 .../htmlwidgets-1.5.2/htmlwidgets.js | 0 .../site_libs}/jquery-1.11.3/jquery.min.js | 0 .../site_libs}/jquery-1.12.4/LICENSE.txt | 0 .../site_libs}/jquery-1.12.4/jquery.min.js | 0 .../site_libs}/jquery-3.6.0/jquery-3.6.0.js | 0 .../jquery-3.6.0/jquery-3.6.0.min.js | 0 .../jquery-3.6.0/jquery-3.6.0.min.map | 0 .../navigation-1.1/codefolding-lua.css | 9 + .../site_libs}/navigation-1.1/codefolding.js | 8 +- .../site_libs}/navigation-1.1/sourceembed.js | 0 .../site_libs}/navigation-1.1/tabsets.js | 0 style.html => docs/style.html | 107 +- docs/styles.css | 39 + 166 files changed, 10729 insertions(+), 342 deletions(-) create mode 100644 docs/.DS_Store create mode 100644 docs/LICENSE create mode 100644 docs/config_automation.yml rename contact.html => docs/contact.html (84%) rename editing.html => docs/editing.html (73%) rename git_actions.html => docs/git_actions.html (69%) rename hosting.html => docs/hosting.html (75%) rename index.html => docs/index.html (82%) create mode 100644 docs/resources/.DS_Store create mode 100644 docs/resources/dictionary.txt create mode 100644 docs/resources/header.html create mode 100644 docs/resources/ignore-urls.txt create mode 100644 docs/resources/images/.DS_Store create mode 100644 docs/resources/images/actions.png create mode 100644 docs/resources/images/add_rule.png create mode 100644 docs/resources/images/blue.png create mode 100644 docs/resources/images/branch_rule.png create mode 100644 docs/resources/images/branches.png create mode 100644 docs/resources/images/checks.png create mode 100644 docs/resources/images/checks2.png create mode 100644 docs/resources/images/classic_tokens.png create mode 100644 docs/resources/images/create-repo.png create mode 100644 docs/resources/images/developer_settings.png create mode 100644 docs/resources/images/emoji.png create mode 100644 docs/resources/images/example_image.png create mode 100755 docs/resources/images/favicon.ico create mode 100644 docs/resources/images/general.png create mode 100644 docs/resources/images/generate_classic.png create mode 100644 docs/resources/images/gh_pat_set_up.png create mode 100644 docs/resources/images/icons.png create mode 100644 docs/resources/images/main_branch.png create mode 100644 docs/resources/images/more_icons.png create mode 100644 docs/resources/images/more_icons_result.png create mode 100644 docs/resources/images/navbar.png create mode 100644 docs/resources/images/page_modification.png create mode 100644 docs/resources/images/pages.png create mode 100644 docs/resources/images/render_error.png create mode 100644 docs/resources/images/render_fail.png create mode 100644 docs/resources/images/render_fail2.png create mode 100644 docs/resources/images/render_fail_details.png create mode 100644 docs/resources/images/repo_action_token.png create mode 100644 docs/resources/images/set_up_token.png create mode 100644 docs/resources/images/setting_gh_pat.png create mode 100644 docs/resources/images/settings.png create mode 100644 docs/resources/images/spelling.png create mode 100644 docs/resources/images/theme.png create mode 100644 docs/resources/images/title.png create mode 100644 docs/resources/images/url_check.png create mode 100644 docs/resources/images/urls.png create mode 100644 docs/resources/images/usersettings.png create mode 100644 docs/resources/images/website_setup.png create mode 100644 docs/resources/images/workflows.png rename setup.html => docs/setup.html (61%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/bootstrap-theme.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/bootstrap-theme.css.map (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/bootstrap-theme.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/bootstrap.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/bootstrap.css.map (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/bootstrap.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/cerulean.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/cosmo.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/darkly.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/flatly.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/Lato.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/LatoBold.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/LatoItalic.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/NewsCycle.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/NewsCycleBold.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/OpenSans.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/OpenSansBold.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/OpenSansBoldItalic.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/OpenSansItalic.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/OpenSansLight.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/OpenSansLightItalic.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/Raleway.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/RalewayBold.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/Roboto.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/RobotoBold.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/RobotoLight.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/RobotoMedium.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/SourceSansPro.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/SourceSansProBold.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/SourceSansProItalic.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/SourceSansProLight.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/fonts/Ubuntu.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/journal.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/lumen.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/paper.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/readable.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/sandstone.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/simplex.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/spacelab.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/united.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/css/yeti.min.css (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/fonts/glyphicons-halflings-regular.eot (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/fonts/glyphicons-halflings-regular.svg (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/fonts/glyphicons-halflings-regular.ttf (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/fonts/glyphicons-halflings-regular.woff (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/fonts/glyphicons-halflings-regular.woff2 (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/js/bootstrap.js (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/js/bootstrap.min.js (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/js/npm.js (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/shim/html5shiv.min.js (100%) rename {site_libs => docs/site_libs}/bootstrap-3.3.5/shim/respond.min.js (100%) rename {site_libs => docs/site_libs}/crosstalk-1.1.0.1/css/crosstalk.css (100%) rename {site_libs => docs/site_libs}/crosstalk-1.1.0.1/js/crosstalk.js (100%) rename {site_libs => docs/site_libs}/crosstalk-1.1.0.1/js/crosstalk.js.map (100%) rename {site_libs => docs/site_libs}/crosstalk-1.1.0.1/js/crosstalk.min.js (100%) rename {site_libs => docs/site_libs}/crosstalk-1.1.0.1/js/crosstalk.min.js.map (100%) rename {site_libs => docs/site_libs}/datatables-binding-0.15/datatables.js (100%) rename {site_libs => docs/site_libs}/datatables-css-0.0.0/datatables-crosstalk.css (100%) rename {site_libs => docs/site_libs}/dt-core-1.10.20/css/jquery.dataTables.extra.css (100%) rename {site_libs => docs/site_libs}/dt-core-1.10.20/css/jquery.dataTables.min.css (100%) rename {site_libs => docs/site_libs}/dt-core-1.10.20/js/jquery.dataTables.min.js (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/css/all.css (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/css/v4-shims.css (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-brands-400.eot (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-brands-400.svg (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-brands-400.ttf (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-brands-400.woff (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-brands-400.woff2 (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-regular-400.eot (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-regular-400.svg (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-regular-400.ttf (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-regular-400.woff (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-regular-400.woff2 (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-solid-900.eot (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-solid-900.svg (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-solid-900.ttf (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-solid-900.woff (100%) rename {site_libs => docs/site_libs}/font-awesome-5.1.0/webfonts/fa-solid-900.woff2 (100%) create mode 100644 docs/site_libs/font-awesome-6.4.2/css/all.css create mode 100644 docs/site_libs/font-awesome-6.4.2/css/all.min.css create mode 100644 docs/site_libs/font-awesome-6.4.2/css/v4-shims.css create mode 100644 docs/site_libs/font-awesome-6.4.2/css/v4-shims.min.css create mode 100644 docs/site_libs/font-awesome-6.4.2/webfonts/fa-brands-400.ttf create mode 100644 docs/site_libs/font-awesome-6.4.2/webfonts/fa-brands-400.woff2 create mode 100644 docs/site_libs/font-awesome-6.4.2/webfonts/fa-regular-400.ttf create mode 100644 docs/site_libs/font-awesome-6.4.2/webfonts/fa-regular-400.woff2 create mode 100644 docs/site_libs/font-awesome-6.4.2/webfonts/fa-solid-900.ttf create mode 100644 docs/site_libs/font-awesome-6.4.2/webfonts/fa-solid-900.woff2 create mode 100644 docs/site_libs/font-awesome-6.4.2/webfonts/fa-v4compatibility.ttf create mode 100644 docs/site_libs/font-awesome-6.4.2/webfonts/fa-v4compatibility.woff2 rename {site_libs => docs/site_libs}/header-attrs-2.10/header-attrs.js (100%) rename {site_libs => docs/site_libs}/header-attrs-2.11/header-attrs.js (100%) create mode 100644 docs/site_libs/header-attrs-2.25/header-attrs.js rename {site_libs => docs/site_libs}/highlightjs-9.12.0/default.css (100%) rename {site_libs => docs/site_libs}/highlightjs-9.12.0/highlight.js (100%) rename {site_libs => docs/site_libs}/highlightjs-9.12.0/textmate.css (100%) rename {site_libs => docs/site_libs}/htmlwidgets-1.5.2/htmlwidgets.js (100%) rename {site_libs => docs/site_libs}/jquery-1.11.3/jquery.min.js (100%) rename {site_libs => docs/site_libs}/jquery-1.12.4/LICENSE.txt (100%) rename {site_libs => docs/site_libs}/jquery-1.12.4/jquery.min.js (100%) rename {site_libs => docs/site_libs}/jquery-3.6.0/jquery-3.6.0.js (100%) rename {site_libs => docs/site_libs}/jquery-3.6.0/jquery-3.6.0.min.js (100%) rename {site_libs => docs/site_libs}/jquery-3.6.0/jquery-3.6.0.min.map (100%) create mode 100644 docs/site_libs/navigation-1.1/codefolding-lua.css rename {site_libs => docs/site_libs}/navigation-1.1/codefolding.js (88%) rename {site_libs => docs/site_libs}/navigation-1.1/sourceembed.js (100%) rename {site_libs => docs/site_libs}/navigation-1.1/tabsets.js (100%) rename style.html => docs/style.html (72%) create mode 100644 docs/styles.css diff --git a/.github/.DS_Store b/.github/.DS_Store index 36b372c72cba58418798b30534145e40b446efdb..127299e8a826f391959f5c9d0ab1f804f003e56d 100644 GIT binary patch delta 18 acmZoMXfc?uYU9Q*_K6Mbo7p-3@&f=#j0Z>n delta 20 ccmZoMXfc?uiji^S#xVAY4Q!j)IsWnk08ZxzNdN!< diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index e52060a..e7b6079 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -37,7 +37,7 @@ jobs: git checkout -b $branch_name || echo branch exists git push --set-upstream origin $branch_name shell: bash - + outputs: public_repository: "${{ steps.public_repository.outputs.public }}" toggle_spell_check: "${{ env.SPELL_CHECK }}" @@ -140,7 +140,7 @@ jobs: id: build-components run: | course_name=$(head -n 1 _website.yml | cut -d'"' -f 2| tr " " "-") - website_link=$(echo "https://htmlpreview.github.io/?https://raw.githubusercontent.com/$GITHUB_REPOSITORY/preview-${{ github.event.pull_request.number }}/index.html") + website_link=$(echo "https://htmlpreview.github.io/?https://raw.githubusercontent.com/$GITHUB_REPOSITORY/preview-${{ github.event.pull_request.number }}/docs/index.html") echo ::set-output name=website_link::$website_link echo ::set-output name=time::$(date +'%Y-%m-%d') echo ::set-output name=commit_id::$GITHUB_SHA diff --git a/.github/workflows/render-site.yml b/.github/workflows/render-site.yml index 41dc1ac..9e4f5af 100644 --- a/.github/workflows/render-site.yml +++ b/.github/workflows/render-site.yml @@ -15,7 +15,6 @@ on: - '**.Rmd' - styles.css - _site.yml - - subdir_html/*.Rmd - resources/images/*.png - resources/images/favicon.ico - site_libs/* @@ -63,11 +62,6 @@ jobs: id: site run: Rscript -e "rmarkdown::render_site()" - # We may have html files that we want to render to add as links on the pages -these will be stored in a dir called subdir_html - - name: Render subdir_html - id: subdir_html - run: Rscript -e "for (i in list.files(path = './subdir_html', pattern = 'Rmd$', recursive = TRUE, full.names = TRUE)){rmarkdown::render(i)}" - # This checks on the steps before it and makes sure that they completed. # If the renders didn't complete we don't want to commit the file changes - name: Check on render steps @@ -82,8 +76,7 @@ jobs: git config --system --add safe.directory $GITHUB_WORKSPACE git config --local user.email "actions@github.com" git config --local user.name "GitHub Actions" - git add --force *.html - git add --force subdir_html/*.html + git add --force docs/* git add --force site_libs/* git commit -m 'Render site' || echo "No changes to commit" git push origin main || echo "No changes to push" diff --git a/_site.yml b/_site.yml index ee16daa..7f07604 100644 --- a/_site.yml +++ b/_site.yml @@ -1,5 +1,5 @@ name: OTTR Template Website -output_dir: '.' +output_dir: 'docs' navbar: title: OTTR Web left: diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..77555c87d9d1fe207cf36afc41838d37fe42ff4b GIT binary patch literal 6148 zcmeHKOG*P#5UkcL0usp5<-3A67(zUO2T+^{f`O65>}Tbq(r~fejPf6NI0V(jW6tKniVY}g#s<+NA=e@SkpXgrmMR(&mC=Ah# kiP4U^@pgP0MOoK;&F5X=m>6{CgHF`Xfa@ZY0)MT*8L8S9*#H0l literal 0 HcmV?d00001 diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..151639f --- /dev/null +++ b/docs/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 jhudsl + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/docs/config_automation.yml b/docs/config_automation.yml new file mode 100644 index 0000000..12d9dd0 --- /dev/null +++ b/docs/config_automation.yml @@ -0,0 +1,24 @@ + +##### Checks run at pull request ##### +# Check quiz formatting +check-quizzes: no +# Check that urls in the content are not broken +url-checker: yes +# Render preview of content with changes (Rmd's and md's are checked) +render-preview: yes +# Spell check Rmds and quizzes +spell-check: yes +# Style any R code +style-code: yes +# Test build the docker image if any docker-relevant files have been changed +docker-test: no + +##### Renderings run upon merge to main branch ##### +# Rendering each platform's content +render-bookdown: yes +render-leanpub: yes +render-coursera: no + +# What docker image should be used for rendering? +# The default is jhudsl/base_ottr:main +rendering-docker-image: 'jhudsl/base_ottr:main' diff --git a/contact.html b/docs/contact.html similarity index 84% rename from contact.html rename to docs/contact.html index 4b5a503..e7feefc 100644 --- a/contact.html +++ b/docs/contact.html @@ -13,8 +13,8 @@ Contact Us - - + + @@ -32,8 +32,8 @@ - - + + @@ -61,6 +61,7 @@ + @@ -86,6 +87,9 @@ summary { display: list-item; } +details > summary > p:only-child { + display: inline; +} pre code { padding: 0; } @@ -142,11 +146,15 @@ href = "index.html"; var menuAnchor = $('a[href="' + href + '"]'); - // mark it active - menuAnchor.tab('show'); - - // if it's got a parent navbar menu mark it active as well - menuAnchor.closest('li.dropdown').addClass('active'); + // mark the anchor link active (and if it's in a dropdown, also mark that active) + var dropdown = menuAnchor.closest('li.dropdown'); + if (window.bootstrap) { // Bootstrap 4+ + menuAnchor.addClass('active'); + dropdown.find('> .dropdown-toggle').addClass('active'); + } else { // Bootstrap 3 + menuAnchor.parent().addClass('active'); + dropdown.addClass('active'); + } // Navbar adjustments var navHeight = $(".navbar").first().height() + 15; @@ -175,8 +183,8 @@ border-radius: 4px; } -.tabset-dropdown > .nav-tabs > li.active:before { - content: ""; +.tabset-dropdown > .nav-tabs > li.active:before, .tabset-dropdown > .nav-tabs.nav-tabs-open:before { + content: "\e259"; font-family: 'Glyphicons Halflings'; display: inline-block; padding: 10px; @@ -184,16 +192,9 @@ } .tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before { - content: ""; - border: none; -} - -.tabset-dropdown > .nav-tabs.nav-tabs-open:before { - content: ""; + content: "\e258"; font-family: 'Glyphicons Halflings'; - display: inline-block; - padding: 10px; - border-right: 1px solid #ddd; + border: none; } .tabset-dropdown > .nav-tabs > li.active { @@ -237,7 +238,7 @@