New Course - Templates to Edit

Abierto
  • ¿Algo no está bien?
#2 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
dockerfile, markdown, r
Área
content, documentation

Línea de trabajo

Start with the linked writing_content.html guide, then review README.md, index.Rmd, 01-intro.Rmd, 02-chapter_of_course.Rmd, _bookdown.yml, and book.bib. Update the course and chapter metadata, choose any style set, and adjust docker/Dockerfile and the index.Rmd package chunk if needed. Done means the course renders correctly and the style preview is checked before opening a pull request.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

automated training issue

Follow the instructions here in ottrproject.org for details on how to start editing your OTTR course

The following files need to be edited to get this new course started!

Files that need edited upon creating a new course.
  • README.md - Fill in all the { }.
  • index.Rmd - title: should be updated.
  • 01-intro.Rmd - replace the information there with information pertinent to this new course.
  • 02-chapter_of_course.Rmd - This Rmd has examples of how to set things up, if you don't need it as a reference, it can be deleted.
Files that need to be edited upon adding each new chapter (including upon creating a new course):
  • _bookdown.yml - The list of Rmd files that need to be rendered needs to be updated. See instructions.
  • book.bib - any citations need to be added. See instructions.
Picking a style

See more about customizing style on this page in the guide.
By default this course template will use the jhudsl data science lab style. However, you can customize and switch this to another style set.

Using a style set

Read more about the style sets here.

  • On a new branch, copy the style-sets/<set-name>/index.Rmd and style-sets/<set-name>/_output.yml to the top of the repository to overwrite the default index.Rmd and _output.yml.
  • Copy over all the files in the style-sets/<set-name>/copy-to-assets to the assets folder in the top of the repository.
  • Create a pull request with these changes, and double check the rendered preview to make sure that the style is what you are looking for.
Files that need to be edited upon adding new packages that the book's code uses:
  • docker/Dockerfile needs to have the new package added so it will be installed. See instructions.
  • The code chunk in index.Rmd should be edited to add the new package.
Lenguaje dominante
JavaScript
Estrellas
2
Forks
0
Sin PR fusionados en 30 d

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de fhdsl/Intro_to_Command_Line

Todos los issues de fhdsl/Intro_to_Command_Line

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.