-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Change output directory of student guide #239
base: main
Are you sure you want to change the base?
Conversation
|
No spelling errors! 🎉 |
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-02-25 with changes from the latest commit fc01746 |
Hey @avahoffman what do you think about moving the It was a bit confusing to have rendered files showing up in Regardless of whether or not we change this, I'm planning to go through and fix all the repos that were having trouble rendering the student guides, so this seemed like a good time to make any changes. So, two things:
|
What
Set the output directory for the student guide to be
student-guide/docs
Why?
I think it's confusing to have the .md files cluttering up the student-guide directory, when they are files that nobody should be touching. (They are generated and then not removed during the rendering process, see https://forum.posit.co/t/why-does-bookdown-keep-the-md-files-with-new-session-yes/47684 for why).
This PR:
student-guide/
and render-all.ymlso they can find it09-student_guide.Rmd
->student-guide.Rmd
, adds some instructions, and adds it to the AnVIL_Template book so it gets renderedstudent-guide/_bookdown.yml
from sync.ymlNote: I took out this line
course_name=$(head -n 1 student-guide/_bookdown.yml | cut -d'"' -f 2| tr " " "-")
from pull-request.yml because:a) It was fragile, it broke when I moved the settings in _bookdown.yml around
b) We're not using it, we've hardcoded the name of the file as "Student_Guide.docx"
Then, in other repos I will:
pull-request.yml
(by sending out a sync)student-guide.Rmd
,student-guide/_bookdown.yml
, andstudent-guide/_output.yml
as neededstudent-guide/
config_automation.yml
- I don't think there's any reason not to have it on by default? There's no link to it in the rendered version of the book unless someone adds it manually.