Skip to content
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.

Sign up for GitHub

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

Jump to bottom

update build process #25

Merged
merged 13 commits into from
Nov 14, 2020
Merged

update build process #25

merged 13 commits into from
Nov 14, 2020

Conversation

zkamvar
Copy link
Contributor

@zkamvar zkamvar commented Nov 10, 2020 •
edited
Loading

Big change for the build process

  • files generated during the knitting process are now dumped into site/build/assets and not into the episodes/ directory, which makes keeping track of committed files easier.
  • generated markdown files get a sandpaper-source yaml item to keep track of the source file.
  • 3 new directories added: learners, instructors, and profiles for information for learners, instructors, and learner profiles associated with the lesson
  • Code of Conduct, License, and Setup templates added
  • users can now set and manipulate the order of the files in the dropdowns listed above (see Breaking Change: Rethink Lesson Folder Organization #22)
  • extras is no longer a folder in episodes/
  • some questionable mucking about with file paths has gone on and I'm glad things are sticking together again.

I've also thought a bit about the deployment aspect. Because we are ignoring everything that goes on inside of the site/ folder, we can create separate worktrees inside of that folder for the md-sources and the gh-pages branch and not have to change much of the infrastructure.

This will fix #24 and fix #22

@zkamvar zkamvar changed the title use site/built/assets/ as knitr wd update build process Nov 10, 2020
zkamvar added 12 commits November 10, 2020 16:13
@zkamvar
simplify build_markdown
911b0a5 
I've created a new function called get_build_status that checks the md5
sums of the Rmd file against the sandpaper digest of the built markdown
file. This is a step toward making this more modular, but definitely is
not all the way there. (see
#19 and
#22)
@zkamvar
rename get_episode_slug to get_slug
101734d
@zkamvar
built file fetching is now recursive
3f43e17
@zkamvar
update paths and information
ff66dc7 
a new line, `sandpaper-source` is added to the YAML file to make hunting
for the source file a bit easier

I've also started an attempt at revamping the sources of truth for the
built files since these will live in different places depending on the
build environment... at the moment it's going horribly and I'm probably
digging myself into a bigger pit ᕕ( ᐛ )ᕗ
@zkamvar
update paths and need a bit of a rethink
5f0f1c8
@zkamvar
add yaml items and templates
10551df
@zkamvar
rename _schedule functions to _episode
17063b3
@zkamvar
rename clear_ -> reset_
e441c80
@zkamvar
made getters and setters more general
d96bb58
@zkamvar
update build_markdown to consider other dirs
6bbda28 
This is definitely not in the state I would like it style-wise, but it
gets the job done for now. I've made build_markdown take into account
the setup, code of conduct, license, and the extra three folders. It
seems to work!
@zkamvar
ugh
0380a64 
I've cleaned up the mess I made because I now realize that I can create
the workdirs inside of the site directory.... is it good? Maybe Is it
safe? Probably?
@zkamvar
update NEWS
b4208a6
@zkamvar zkamvar marked this pull request as ready for review November 13, 2020 23:52
@zkamvar zkamvar merged commit 32fd4eb into master Nov 14, 2020
@zkamvar zkamvar deleted the znk-address-22 branch November 14, 2020 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@zkamvar