Skip to content

Switching out wiki links#12

Merged
kweav merged 9 commits intomainfrom
switch_wiki
May 30, 2025
Merged

Switching out wiki links#12
kweav merged 9 commits intomainfrom
switch_wiki

Conversation

@kweav
Copy link
Contributor

@kweav kweav commented May 16, 2025

Just switched out one link so far. Creating a PR for checks, but not requesting review yet

Switched out as many wiki links as I could and addressed the URL checker while I was at it. I know that some of the things may be getting rewritten -- just wanted the links to work as much as possible in the mean time

@github-actions
Copy link
Contributor

github-actions bot commented May 16, 2025

OTTR Check Results

Summary

  • Spelling check: ✅ PASSED (0 errors found, threshold: 0)
  • URL check: ✅ PASSED (0 errors found, threshold: 0)

🎉 All checks passed!

Last Updated: 2025-05-30-15:49:26

@github-actions
Copy link
Contributor

github-actions bot commented May 16, 2025

Re-rendered previews from the latest commit:

* note not all html features will be properly displayed in the "quick preview" but it will give you a rough idea.

Updated at 2025-05-30 with changes from the latest commit ea58943

@kweav
Copy link
Contributor Author

kweav commented May 16, 2025

ottrproject.github.io % grep "wiki" *
  • course_publishing.Rmd:To publish your content using Bookdown, you can utilize Github Pages by following the repository setup instructions provided [here](https://github.com/ottrproject/OTTR_Template/wiki/Starting-a-new-course-with-this-template#set-up-github-pages). It's important to note that Bookdown serves as a fundamental component for utilizing other publishing platforms such as Coursera or Leanpub. Therefore, if you intend to use Coursera or Leanpub, you will need to publish your content using Bookdown.
  • course_publishing.Rmd:Note that if you wish to keep your quizzes and their answers hidden, there is some additional setup involved with this process and you will need to create a separate private OTTR_Quizzes repository to store these quizzes. Start with [these instructions](https://github.com/ottrproject/OTTR_Template/wiki/Making-quizzes-private) first if you want your quizzes and answers to be hidden.
  • course_publishing.Rmd:The ottrpalpackage can handle most of the formatting tasks for links and other elements for you, as long as you have followed the formatting instructions provided in theSetting up images section of [this Wiki](https://github.com/ottrproject/OTTR_Template/wiki/Setting-up-images-and-graphics).
  • course_publishing.Rmd:In your [config_automation.yml file](https://github.com/ottrproject/OTTR_Template/wiki/How-to-set-up-and-customize-GitHub-actions-robots), you will need to turn on two Actions in particular:
  • course_publishing.Rmd:[See more instructions on how to port a course made from these templates to Coursera](https://github.com/ottrproject/OTTR_Template/wiki/Publishing-on-Courseraa).
  • course_publishing.Rmd:- [ ] A [GH_PAThas been set in the main Template and the_Quizzesrepository if you are using a separate_Quizzes repository](https://github.com/ottrproject/OTTR_Template/wiki/Setting-up-GitHub-secrets).
  • course_publishing.Rmd:- [ ] This repo has been enrolled in [automatic updates from the original template](https://github.com/ottrproject/OTTR_Template/wiki/Receiving-template-updates).
  • customize-robots.Rmd:This is only relevant if you have [your own Docker image you are managing for your course](https://github.com/ottrproject/OTTR_Template/wiki/Using-Docker#starting-a-new-docker-image). If changes are made to Docker-relevant files: Dockerfile, install_github.R, or github_package_list.tsv, this will test re-build the Docker image.
  • customize-robots.Rmd: If it is successfully built, then it makes sense to merge it to mainbut the Docker Image will not be pushed toDockerhub automatically. [Follow these instructions to push your Docker image to Dockerhub](https://github.com/ottrproject/OTTR_Template/wiki/Using-Docker#pushing-the-docker-image).
  • customize-robots.Rmd:For publishing to Leanpub, make sure that the render Leanpub option is set to yes: render-leanpub: yes. See more details about publishing to Leanpub [here](https://github.com/ottrproject/OTTR_Template/wiki/Publishing-on-Leanpub).
  • customize-robots.Rmd:For publishing to Coursera, make sure render Coursera option is set to yes: render-coursera: yes. See more details about publishing to Coursera [here](https://github.com/ottrproject/OTTR_Template/wiki/Publishing-on-Coursera).
  • customize-style.Rmd:1. [Create a pull request](https://github.com/ottrproject/OTTR_Template/wiki/About-pull-request-review) with these changes, and double check the rendered preview to make sure that the style is what you are looking for. grep: docs: Is a directory
  • editing_website.Rmd:Actions](https://github.com/ottrproject/OTTR_Template/wiki/How-to-set-up-and-customize-GitHub-actions-robots).
  • faqs.Rmd:Your Google Slides presentation you have tried to retrieve a slide from with ottrpal::include_slide()is not public. Your Google Slide document must be set toAnyone with a link. See [this article for more details.](https://support.wix.com/en/article/setting-permissions-for-google-drive-files-and-folders#:~:text=Settings%20Permissions%20for%20a%20Google,edit%20and%20comment%20as%20well.) The renders will fail if this is not set! See the [setting up images and graphics section](https://github.com/ottrproject/OTTR_Template/wiki/Setting-up-images-and-graphics) for more details.
  • getting_started.Rmd:**Warning**: If you go to your URL right now (before you've pushed any file changes) you might see a 404 error because nothing has been triggered to be rendered. You can check the URL after you file your first pull request (which we will guide you through [in the next section](https://github.com/ottrproject/OTTR_Template/wiki/Start-editing-your-course).
  • getting_started.Rmd:To enable the full functionality of [GitHub Actions](https://github.com/ottrproject/OTTR_Template/wiki/How-to-set-up-and-customize-GitHub-actions-robots) in this repository, it is necessary to grant appropriate permissions. To achieve this, you should add jhudsl-robot as a collaborator to your repository with write permissions.
  • more_features.Rmd:In Coursera, you can add the credits table URL as an ungraded plugin ([the same as described here for adding chapter content](https://github.com/ottrproject/OTTR_Template/wiki/Publishing-on-Coursera#navigating-to-your-course-on-coursera)). This should be added at the beginning of your course, right after the introduction.
  • writing_content_courses.Rmd:Actions](https://github.com/ottrproject/OTTR_Template/wiki/How-to-set-up-and-customize-GitHub-actions-robots).
  • writing_content_courses.Rmd:pages](https://github.com/ottrproject/OTTR_Template/wiki/Starting-a-new-course-with-this-template#set-up-github-pages)

@kweav
Copy link
Contributor Author

kweav commented May 22, 2025

Couldn't easily find a replacement for the "Setting-up-images-and-graphics" from the wiki for faqs.Rmd and course_publishing.Rmd

Copy link
Contributor

@avahoffman avahoffman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

## Hosting your course on Leanpub

_Finalizing your course on Leanpub can be tricky_. We have created a course, [Using Leanpub](https://ottrproject.org/Using_Leanpub/index.html), to help guide you.
_Finalizing your course on Leanpub can be tricky_. We have created a course, [Using Leanpub](https://hutchdatascience.org/Using_Leanpub/index.html), to help guide you.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hopefully this isn't horribly out of date lol

* Submit a response in our [OTTR Feedback Google Form](https://forms.gle/jGQnd5oemHWyuUq28) by providing the information for your new repo (organization or username as well as the new repo name) in the "Do you have any overall suggestions for OTTR?" question and we can make edits to the `sync.yml` file for you.
* Open an issue in the relevant repo [(links in table below)](#links-to-open-an-issue-in-an-ottr-template-repository) providing us the information about your repo (organization or username as well as the new repo name) and we can make edits to the `sync.yml` file for you.
* Edit the sync file by creating a fork and opening a pull request from that fork. We provide instructions for that below [in the section Making edits to these files if you are not part of the jhudsl Github organization](#making-edits-to-this-file-if-you-are-not-part-of-the-jhudsl-github-organization).
* Edit the sync file by creating a fork and opening a pull request from that fork. We provide instructions for that below [in the section Making edits to these files if you are not part of the jhudsl Github organization](#making-edits-to-this-file-if-you-are-not-part-of-the-jhudsl-github-organization).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason this link (and the one above) are relative not absolute links? I personally don't care either way just wondering.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure -- looks like that section with relative links was added by me when I made some edits to documentation. @carriewright11 would we prefer all of the links to be absolute?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it might be easier for fixing links in situations like this if it is absolute

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Absolute now :)

@kweav
Copy link
Contributor Author

kweav commented May 29, 2025

Couldn't easily find a replacement for the "Setting-up-images-and-graphics" from the wiki for faqs.Rmd and course_publishing.Rmd

@carriewright11 pointed me to this link: https://www.ottrproject.org/writing_content_courses.html#set-up-images

Will switch out!

faqs.Rmd Outdated
## Contact Info

If you have a question that's not addressed by this website or just wanna chat with us about something else, please email us at itcrtrainingnetwork@gmail.com OR you can [leave a GitHub issue here](https://github.com/ottrproject/OTTR_Template/issues/new).
If you have a question that's not addressed by this website or just wanna chat with us about something else, please email us at itcrtrainingnetwork@gmail.com OR you can [leave a GitHub issue here](https://github.com/ottrproject/OTTR_Template/issues/new).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should request them to @ us? I don't get pinged otherwise.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have asked them to at us here and have switched other parts where it still had them at or assign Candace

@kweav
Copy link
Contributor Author

kweav commented May 30, 2025

Merging to handle Issue #6

@kweav kweav merged commit 6617991 into main May 30, 2025
7 checks passed
@kweav kweav deleted the switch_wiki branch May 30, 2025 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants