forked from ottrproject/ottr_documentation_dev
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.qmd
More file actions
91 lines (69 loc) · 3.98 KB
/
index.qmd
File metadata and controls
91 lines (69 loc) · 3.98 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
---
title: "**<img src='./resources/images/basic_otter_water.PNG' width = 100px> OTTR - Website and Online Course Tools**"
output:
html_document
---
<div class = "banner_color">
<br>
</div>
<p style="font-size: 16px;">OTTR (Open-source Tools for Training Resources ) is a set of tools and templates to help you make **websites, online courses, and dashboards** more easily (and for free)!</p>
<div style="position: relative; width: 100%; height: 0; padding-top: 77.2727%;
padding-bottom: 0; box-shadow: 0 2px 8px 0 rgba(63,69,81,0.16); margin-top: 1.6em; margin-bottom: 0.9em; overflow: hidden;
border-radius: 8px; will-change: transform;">
<iframe loading="lazy" style="position: absolute; width: 100%; height: 100%; top: 0; left: 0; border: none; padding: 0;margin: 0;"
src="https://www.canva.com/design/DAGwn4eF5mk/2RhR8mbSJxGL7XiaHSXPHg/view?embed" allowfullscreen="allowfullscreen" allow="fullscreen" alt = "OTTR Flavors and their uses">
</iframe>
</div>
<a href="https://www.canva.com/design/DAGwn4eF5mk/2RhR8mbSJxGL7XiaHSXPHg/view?utm_content=DAGwn4eF5mk&utm_campaign=designshare&utm_medium=embeds&utm_source=link" target="_blank" rel="noopener">OTTR at a Glance</a> by ITN
#### Benefits for all OTTR options:
- No software installations needed
- Automatically preview content on [GitHub](https://github.com/) before you publish
- Automatically check spelling (and customize your dictionary!)
- Automatically and periodically check for broken links
- Easily customize branding
- Easily include code (and avoid version difference issues using Docker containers)
```{r, fig.align='center', fig.alt= "OTTR helps build github based websites with less hassle. Catch potential mistakes before they go live", echo = FALSE, out.width= "40%"}
knitr::include_graphics("./resources/images/why-ottr.png")
```
#### Benefits for specific uses:
- Websites can be created using [quarto](https://quarto.org/) or [bookdown](https://bookdown.org/)
- Courses can be easily formatted for learning platforms like [coursera](https://www.coursera.org/) and [Leanpub](https://leanpub.com/) (only edit once and it gets propagated to all locations - making for **easy updates**!)
- Metrics can be gathered from a variety of sources for dashboards
<br>
(*Note that you will need to establish a publishing contract with coursera if you want to publish there)
Check out this short video about OTTR:
<p align="center"><iframe width="560" height="315" src="https://www.youtube.com/embed/oQ8d42fSn0o" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></p>
#### How to use OTTR:
1. Edit and write websites and courses in [R Markdown files](https://rmarkdown.rstudio.com/) or [Quarto](https://quarto.org/docs/output-formats/html-basics.html)
1. Use GitHub to host your content, we will walk you through how!
1. Let the GitHub actions in our tools do all the checks and rendering so you don't have too
1. Update your content as needed based on the errors OTTR finds and the preview
1. Publish your websites and courses!
<br>
#### How to Cite OTTR:
Please cite our [OTTR manuscript here!](https://www.tandfonline.com/doi/full/10.1080/26939169.2022.2118646)📝👀
<details>
<summary>Click here for the BibTeX formatted citation</summary>
```
@article{ottr,
author = {Candace Savonen, Carrie Wright, Ava M. Hoffman, John Muschelli, Katherine Cox, Frederick J. Tan and Jeffrey T. Leek},
title = {Open-source Tools for Training Resources – OTTR},
journal = {Journal of Statistics and Data Science Education},
volume = {31},
number = {1},
pages = {57-65},
year = {2023},
publisher = {Taylor & Francis},
doi = {10.1080/26939169.2022.2118646},
URL = {https://doi.org/10.1080/26939169.2022.2118646},
eprint = {https://doi.org/10.1080/26939169.2022.2118646}
}
```
</details>
<br>
<center>
<a href="https://ottrproject.org/getting_started.html">
<img src="resources/images/getstarted.png" width = 30%>
</a>
</center>
<br>