Skip to content

Commit 6b92d79

Browse files
committed
2 samatha, new READMEs, & move css deps to npm
1 parent 973764e commit 6b92d79

53 files changed

Lines changed: 501 additions & 14979 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/build.yaml‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build the site
1+
name: Build
22
on:
33
workflow_dispatch:
44
push:
@@ -14,10 +14,17 @@ jobs:
1414
fetch-depth: 0
1515
- name: Normalize Unicode in the Previous Commit
1616
uses: buddhist-uni/normalized-unicode-action@v0.3
17+
- uses: actions/setup-node@v3
18+
with:
19+
node-version: 18
20+
cache: 'npm'
21+
cache-dependency-path: 'package-lock.json'
22+
- run: npm ci
23+
- run: bash ./scripts/install-deps.bash
1724
- name: Install build requirements
1825
uses: ruby/setup-ruby@v1
1926
with:
20-
ruby-version: 2.6
27+
ruby-version: 3.1
2128
bundler-cache: true
2229
- name: Build the site
2330
run: |

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
vendor
22
node_modules
3+
assets/webfonts
34
_site
45
.trash
56
.obsidian

‎ACKNOWLEDGEMENTS.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Acknowledgements
3+
---
4+
5+
A BIG thank you to:
6+
7+
- [Google](https://about.google/) for hosting [the file library](https://drive.google.com/drive/folders/1RJi6bEXa25zizGdsm5evCycYuY6a2D8r)
8+
- [GitHub](https://github.com/about/) for hosting the website and its source code, including their [Primer CSS](https://primer.style/) library
9+
- [FontAwesome](https://fontawesome.com/) and [Wikimedia Commons](https://commons.wikimedia.org/wiki/Main_Page) for providing the images used throughout
10+
- [CloudFlare](https://www.cloudflare.com/) for securing the site
11+
- and last but certainly not least: thank you to all the various [content sources](https://www.buddhistuniversity.net/sources/), [creators](https://buddhistuniversity.net/authors/) and [publishers](https://buddhistuniversity.net/publishers/) who generously put their work out for free distribution.
12+
13+
It's a testament to Buddhist generosity that such an expansive and outstanding collection could be compiled (almost entirely) from free material.
14+
15+
The Open Buddhist University is an HTML5 website [built with Jekyll](https://jekyllrb.com/) by Khemarato Bhikkhu.
16+

‎COLLECTION_POLICY.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
title: "Collection Development Policy"
3+
---
4+
5+
This document outlines the method and criteria used for adding new content to the library.
6+
7+
This document is primary for onboarding new contributors, but it may also be of interest to users and patrons of the library.
8+
9+
## Table of Contents
10+
- [Overview](#overview)
11+
- [Inclusion Criteria](#inclusion-criteria)
12+
- [Acceptance Levels](#acceptance-levels)
13+
- [The Structure of the Collection](#ontology)
14+
- [Conclusion](#conclusion)
15+
16+
## Overview
17+
18+
The OBU Library serves **English speakers** with a basic education and an **interest in Buddhism**.
19+
20+
Its collections are **entirely digital** and are a combination of self-hosted files (on GitHub and Google Drive) and links to resources accessible on the broader internet.
21+
Each entry in the library is ideally hosted in two different locations (e.g. at Archive.org and on Google Drive) for redundancy and accessibility.
22+
23+
The usual procedure for ingesting new content from the internet is as follows:
24+
25+
1. Content freely available on the internet or given to OBU for inclusion gets uploaded to [the ingestion folder on Google Drive](https://drive.google.com/drive/folders/16-z8CRbEfo3L8DTUpR76Sq1uCs4Am5b_).
26+
2. That content is then deduped and sorted into "unreviewed" buckets on G-Drive by subject (if you'd like to become a reviewer for a particular subject, send a message and I can invite you to the appropriate subfolder).
27+
3. A reviewer then reviews a piece for acceptance or rejection. (See details below).
28+
4. Accepted pieces (rank3+) are moved to the appropriate folder in [the public Google Drive library](https://drive.google.com/drive/folders/1-zOQ53Le2uYZp6lCjuLZUA38H6zvlrzf) based on what subject that piece teaches (rejected items are archived in Google Drive).
29+
5. When a topical folder on Drive has reached a state of maturity, its contents are added one-by-one to [the site's `_content` library](https://github.com/buddhist-uni/buddhist-uni.github.io/tree/master/_content) and the (Drive) folder is added as a new [`_tag`](https://github.com/buddhist-uni/buddhist-uni.github.io/tree/master/_tags)
30+
6. When that tag has reached a level of maturity, its content is organized into a syllabus which becomes a new [`_course`](https://github.com/buddhist-uni/buddhist-uni.github.io/tree/master/_courses) of the same name. (See [the open issues on GitHub](https://github.com/buddhist-uni/buddhist-uni.github.io/labels/writing) for courses awaiting a volunteer if you're interested in authoring a new course).
31+
32+
## Inclusion Criteria
33+
34+
For inclusion in the OBU library, a given work should be:
35+
36+
1. Truthful and accurate
37+
2. In beautiful and charismatic English
38+
3. Espousing the Dharma and wholesome values
39+
4. Adding a unique perspective
40+
5. On an important topic of wide interest to Buddhists
41+
6. Available for free
42+
7. From a reputable source
43+
8. Difficult to find online
44+
45+
The above factors are to be taken "on balance" such that a deficiency in one area may be compensated for by strength in another.
46+
For example, there are a few [works of fiction](https://buddhistuniversity.net/search/?q=%2Bis%3Afiction) in the library which fail IC1, but whose craft (IC2) and wholesome messages (IC3) make up for their lack of literal truth.
47+
The teachings of Chögyam Trungpa, however, fail IC7 and IC8 so thoroughly as to be inadmissible regardless of the works' other merits.
48+
49+
Note that IC4 (uniqueness) can be applied retroactively.
50+
If a better (more up-to-date, etc) work is found covering the same topic as an older work, than that older work should be archived in favor of the better one.
51+
[*In the Hope of Nibbana*](https://buddhistuniversity.net/content/monographs/in-the-hope-of-nibbana_king-winston) is an example of such a downranked work.
52+
53+
Works that would otherwise not be added to the site for their low score on IC2 and/or IC4 should still be added as rank2 works (see below) if they score highly on IC8 to ensure they remain available online.
54+
55+
## Acceptance Levels
56+
57+
Rather than a binary "accepted or rejected" status, items in the OBU library are given a 1–5 star rating based on their score on the Inclusion Criteria above.
58+
59+
- One-star pieces fail multiple IC categories and are never proactively added to the site. Their files are kept in a private archive on Google Drive of rejected works.
60+
- Two-star pieces fail at most one IC category but receive only lackluster scores on the rest. This is the most common score for items we review. Such pieces are typically not added to the website, though occasionally a borderline rank3 work can be added (especially if it scores well on IC8). Such works are placed in [this Google Drive folder](https://drive.google.com/drive/folders/1Ih3PRUKLHaWzVvoVVkCRuaCzbsjreQXa) and are labeled "📦 Archived" on the site (see the table below).
61+
- Three-star pieces fail at most one IC category and receive strong marks in one or two areas. This is the most common designation for accepted works. They are accepted into the appropriate subfolder on the public-facing Google Drive library and must be added to the site if that folder has already been added.
62+
- Four-star pieces fail at most one IC category but receive very strong marks in multiple other areas. A four-star review means that this piece is highly recommended and should be added to the website right away (unless its IC5 score is particularly low).
63+
- Five-star pieces must fail none of the IC categories and must receive strong marks across the board. These are quite rare. They are not identified immediately, but are selected from the pool of recent four-star additions when it comes time to write the next blog post (usually every couple months).
64+
65+
The following table summarizes the five levels and how they work on the website:
66+
67+
| Ranking | Label | Code | Effect | Example |
68+
|---|---|---|---|---|
69+
| rank1 | 📦 Deprecated | `status: rejected` and `reason: [explanation]` | The work will be delisted everywhere on the website except for search, where it will be downranked. | [The Ancient Path to Enlightenment](https://buddhistuniversity.net/content/av/ancient-path-to-enlightenment_dabei) ([code](https://github.com/buddhist-uni/buddhist-uni.github.io/blob/master/_content/av/ancient-path-to-enlightenment_dabei.md)) was delisted after the video was taken down. |
70+
| rank2 | 📦 Archived | `course: nil` | Archived works are downranked in search and content recommendations. | [One Teacher, Many Traditions](https://buddhistuniversity.net/content/monographs/buddhism-one-teacher-many-traditions_dalai-lama-thunten-chodron) ([code](https://raw.githubusercontent.com/buddhist-uni/buddhist-uni.github.io/master/_content/monographs/buddhism-one-teacher-many-traditions_dalai-lama-thunten-chodron.md)) Failed IC6 and IC4, but scored highly enough on the rest to deserve an "honorable mention" as a rank2 piece |
71+
| rank3 | [none] | `course: [value]` | An accepted work will be featured on the `/tags/[value]` page. | [The Buddha's Remains](https://buddhistuniversity.net/content/articles/buddhas-remains_wallis-glenn) ([code](https://raw.githubusercontent.com/buddhist-uni/buddhist-uni.github.io/master/_content/articles/buddhas-remains_wallis-glenn.md)) Somewhat dry (IC2), niche (IC5) and Googlable (IC8), this otherwise-solid piece was accepted as a standard entry |
72+
| rank4 | ⭐ Recommended | `status: featured` | These works are upranked in search and content recommendations and they get highlighted in content lists. | [The Buddha's Genitals](https://buddhistuniversity.net/content/essays/politics-of-the-buddhas-genitals_sujato) ([code](https://raw.githubusercontent.com/buddhist-uni/buddhist-uni.github.io/master/_content/essays/politics-of-the-buddhas-genitals_sujato.md)) This piece, in contrast, hits solid marks across the board, being a unique and interesting take buried in an online forum. |
73+
| rank5 | 🏅 Featured | both of the above and a link to the work in a blog post | Same as `rank4` but are also highlighted in the newsletter. | [Arhat Invitation during the Song](https://buddhistuniversity.net/content/articles/arhat-invitation-in-the-song_joo-ryan) ([code](https://raw.githubusercontent.com/buddhist-uni/buddhist-uni.github.io/master/_content/articles/arhat-invitation-in-the-song_joo-ryan.md)) ([blog post](https://buddhistuniversity.net/blog/2021/11/19/wandering)) This piece was very interesting and more important than its unassuming title might suggest. It was therefore deemed worthy of featuring in the newsletter. |
74+
75+
Note: to view a piece's ranking directly on the website, click the "Bibtex Data" button and look for the `ranking` field.
76+
77+
## Ontology
78+
79+
As a keen user of this library, it's worth taking some time to familiarize yourself with [the folder structure on Drive](https://drive.google.com/drive/folders/1-zOQ53Le2uYZp6lCjuLZUA38H6zvlrzf).
80+
Contributors to the library should be able to answer basic questions about the collection such as:
81+
82+
1. Where can I find a copy of the Jātaka tales?[^jataka]
83+
2. Where is "The Human World" folder?[^world]
84+
3. What are the subcategories under Buddhist Philosophy?[^philosophy]
85+
86+
Having this structure in your head will help you navigate the collection efficiently and helps reviewers direct works to the correct folders.
87+
88+
### Choosing a Folder
89+
90+
Once a work has been accepted for inclusion, the reviewer must select the folder (and, if it's being added to the website, `tags`) to which this work belongs.
91+
92+
This selection is more art than science, but a few questions are helpful to ask when making the decision:
93+
94+
- What _discourse_ is this work contributing to?
95+
- What does the piece _claim_ to be about (e.g. in its title)?
96+
- Is it actually about something else?
97+
- What did _I personally_ learn from it?
98+
- I would enthusiastically recommend this to someone interested in what?
99+
- Could I imagine this being assigned reading in an undergrad course about ______?
100+
101+
The collection is already quite large, so it's best to be conservative and place works in the smallest conceivable category.
102+
For example, a work about Buddhist Cosmology should be placed in "Cosmology" not in "Philosophy".
103+
104+
### Adding to the site
105+
106+
When a work is added into the website, its `course` field is set to the slug of the folder it was accepted into on Google Drive.
107+
The work may also be tagged with additional `tags` which mark other topics the work is about.
108+
109+
Tags should, but don't have to, correspond to folders on Drive.
110+
If they do, however, a work should not be tagged with both a folder **and** that folder's parent. Obviously a work about `thai` Buddhism is also about `theravada` and a work about `philosophy` is also about right `view`. Tags should mark wildly different places a work may have been added: for example `sutta` and `lay` for a work about Pāḷi discourses to lay people.
111+
112+
## Conclusion
113+
114+
If you have any additional questions about the library not answered in this document, please feel free to [email me](mailto:khemarato.bhikkhu@gmail.com) at any time.
115+
116+
Thank you for your interest in the library and may you be blessed by the blessings of the Triple Gem. 🙏
117+
118+
💎💎💎
119+
120+
### Answers to the Ontology Quiz
121+
122+
[^jataka]: Forms->Indian->Stories->Jataka
123+
124+
[^world]: Inside the "[Cosmology](https://drive.google.com/drive/folders/1-3P5u65MsX2gjuN46xqNV2dJxoAxrQDQ)" folder
125+
126+
[^philosophy]: Right View and Right Thought

0 commit comments

Comments
 (0)