diff --git a/getting_started.Rmd b/getting_started.Rmd index f1a78d1..7dbf911 100644 --- a/getting_started.Rmd +++ b/getting_started.Rmd @@ -30,8 +30,8 @@ If you are not familiar with **Git and GitHub**, we recommend going through thes We offer two suggested approaches for creating content, based on your comfort and interest level in using Git and GitHub: -- [OTTR Entry Level](https://www.ottrproject.org/writing_content.html#ottr-entry-level): If you are not interested in delving into GitHub, you can use this version, which is entirely conducted through the GitHub web browser. -- [OTTR Advanced](https://www.ottrproject.org/writing_content.html#ottr-advanced): If you are already familiar with Git and GitHub or have an interest in starting to use them, we suggest this method. It will involve some additional learning, but acquiring skills in Git and GitHub will be highly beneficial not only for OTTR but also for version control in various other contexts. +- **OTTR Entry Level**: If you are not interested in delving into GitHub, you can use this version, which is entirely conducted through the GitHub web browser. +- **OTTR Advanced**: If you are already familiar with Git and GitHub or have an interest in starting to use them, we suggest this method. It will involve some additional learning, but acquiring skills in Git and GitHub will be highly beneficial not only for OTTR but also for version control in various other contexts. If you choose to use our OTTR Advanced guidance, you will need a method for working with Git. diff --git a/ottr-fy.Rmd b/ottr-fy.Rmd index 1042c8f..e7d3964 100644 --- a/ottr-fy.Rmd +++ b/ottr-fy.Rmd @@ -21,11 +21,11 @@ This set of steps also assumes you are more familiar with GitHub. ### Step 1: Add OTTR files to your current repository -Navigate to the top of your repository and [download this file](https://raw.githubusercontent.com/jhudsl/OTTR_Template/main/scripts/ottr-fy.R). +Navigate to the top of your repository and [download this file](https://github.com/jhudsl/ottr-reports/blob/main/scripts/ottr-fy.R). You can do this by using wget, or by just using the link above and saving it as `ottr-fy.R` in the top of your repository. ``` -wget 'https://raw.githubusercontent.com/jhudsl/OTTR_Template/main/scripts/ottr-fy.R' +wget 'https://github.com/jhudsl/ottr-reports/blob/main/scripts/ottr-fy.R' ``` You've downloaded a script that will download the necessary files to run OTTR in your repository. Take a look at the filenames of what will be downloaded to make sure that you won't accidentally overwrite any of your repository's existing files. @@ -38,17 +38,11 @@ You've downloaded a script that will download the necessary files to run OTTR in - `.github/workflows/render-all.yml` - `.github/workflows/delete-preview.yml` - `.github/workflows/docker-build.yml` -- `scripts/git_repo_check.R` -- `scripts/make_screenshots.R` -- `scripts/quiz-check.R` -- `scripts/spell-check.R` -- `scripts/url-check.R` -- `assets/toc_close.css` #### Files you'll need to edit to customize \* These files also will not be downloaded if you already have set up your repository as a bookdown website and specify this in the upcoming command. -- `_bookdown.yml` +- `_bookdown.yml` or `_site.yml` for a website/course respectively - `_output.yml` - `book.bib` - `assets/big-image.html` @@ -59,7 +53,7 @@ You've downloaded a script that will download the necessary files to run OTTR in - `config_automation.yml` - `assets/style.css` -Run this this script from your command line if your repository is not already a bookdown website. +Run this this script from your command line if your repository is not already a bookdown website. ``` Rscript ottr-fy.R ``` @@ -83,19 +77,15 @@ If they do not automatically start running, you may also want to check in your ` Check your files on this pull request your files and that nothing horrible has happened to your original files (like being overwritten or deleted). -### 2. Add your Rmd or md files to the `_bookdown.yml` file +### 2. Add your Rmd or md files to the `_bookdown.yml` or `_site.yml` file You will almost certainly find that the `Render preview` check will fail (and possibly the spelling and URL checks). -One reason that this will fail is that you will need to edit `_bookdown.yml` to list your Rmds (or mds) in the order they should appear in the course. ([See this section](https://www.ottrproject.org/customize-robots.html#Pull_request_checks:) for more information about these checks and what they are) - -[Follow these instructions](https://www.ottrproject.org/writing_content.html#Step_2_Add_the_name_of_your_new_chapter_to_your__bookdownyml_file) to add your Rmds and mds to the _bookdown.yml file. +One reason that this will fail is that you will need to edit `_bookdown.yml` `_site.yml` to list your Rmds (or mds) in the order they should appear in the course. ([See this section](https://www.ottrproject.org/customize-robots.html#Pull_request_checks:) for more information about these checks and what they are) Make sure to commit this to your branch. -You will also likely want to update your `_output.yml` file. [Read here](https://bookdown.org/yihui/bookdown/output-formats.html) for more about how to customize this `_output.yml` file. - *\ Note! Don't merge this pull request before you finish adding a few settings as described in this next step. ### 3. Set up your repository with the proper settings -From here, you can follow the rest of the steps described in the [Getting Started section](https://www.ottrproject.org/getting_started.html#5_Add_jhudsl-robot_as_a_collaborator). +From here, you can follow the rest of the steps described in the [Getting Started section](https://www.ottrproject.org/getting_started.html#Starting_a_new_OTTR_websitecourse).