Skip to content

Commit

Permalink
refactoring plan - steps in README
Browse files Browse the repository at this point in the history
  • Loading branch information
emilybache committed Jun 28, 2024
1 parent 9dae51e commit eb995c3
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,23 @@ When you push to the main branch, there is a github action that deploys the chan
* Send welcome mail saying you've done those things
* Announce them on Discord & elsewhere

# Development plan for this website
We would like to do some refactoring. This is the plan

1. Improve the build so we don't release a broken site
2. Use Jekyll links everywhere - no "]{/" in project
3. Use defined perma links instead of folder structure
4. Move index pages to their own folder instead of having them in a folder structure
4. Make contributors into a collection
5. Remove layouts that are only used in one place, use html in these pages instead
6. Give learning hours ids (with a script?) and put them in a flat folder structure
7. Supply page templates for collections in git but not included in the jekyll build

## Jekyll Design Principles
* Use collections for objects
* Use liquid as a database
* `_data` is good for things that don't have their own pages
* Routing is best based on configuration not file structure
* If it needs its own layout, write it in html from the start
* Using frontmatter when possible enables jekyll to check that things work
* Using frontmatter when possible enables jekyll to check that things work

0 comments on commit eb995c3

Please sign in to comment.