Skip to content

Commit ff9e541

Browse files
committed
Add document with maintenance notes
1 parent 4fc1fb1 commit ff9e541

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

maintainer-notes.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Notes for site maintenance
2+
===
3+
4+
_tl;dr_ document that summarizes notes on the structure and maintenance of this site.
5+
6+
Bootstrap, Bootswatch, and styling
7+
---
8+
- Build on Twitter Bootstrap
9+
- Styling based on Bootswatch's "Darkly" theme
10+
- Custom modifications to defaults from Bootstrap and Bootswatch are stored in `/stylesheets/bootstrap.scss`
11+
- Jekyll builds Bootstrap, Bootswatchm and custom modifications manually on every build. We don't use a pre-build release CSS file.
12+
- Bootstrap and Bootswatch files are spread across 3 different directories. In all cases, the files are unmodified from the versions found in official releases.
13+
- `/_sass/`
14+
- `/_sass/bootstrap/`: Core Bootstrap Sass styles. New copies can be found in official releases under `bootstrap-sass-<version>.zip/bootstrap-sass-<version>/assets/stylesheets/`.
15+
- `/_sass/_bootswatch.scss`: Bootswatch's functional changes to Bootstrap styling. Can be found on the Bootswatch website or GitHub repo.
16+
- `/_sass/_variables.scss`: Bootswatch's coloring and other visual styles. Can be found on the Bootswatch website or GitHub repo.
17+
- `/javascripts/bootstrap/`: Bootstrap JavaScript helpers. Found in `bootstrap-sass-<version>.zip/bootstrap-sass-<version>/assets/javascripts/`.
18+
- `/fonts/bootstrap`: Bootstrap font files. Found in `bootstrap-sass-<version>.zip/bootstrap-sass-<version>/assets/fonts/bootstrap`.
19+
- File structure here is different from Bootstrap's `assets` directory because we need to have a separate `sass_dir` that contains all our partials.
20+
- If updating to a new version of any of these dependencies, make sure that no variable names have changed -- we override some key variables.
21+
- Always upgrade all of the Bootstrap files and all of the Bootswatch files at the same time, and keep their versions matching.

0 commit comments

Comments
 (0)