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.

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

update docs text to reflect CourtListener API integration #117

Merged
merged 2 commits into from
Aug 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ jobs:

- name: Info
run: |
docker-compose --version
docker version
npm --version

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Install and Run

3. `cd h2o-static`

4. Fire up the web server and build the site: `docker-compose up`
4. Fire up the web server and build the site: `docker compose up`

5. Check out what you built:
- Docker: head to http://localhost:8080/
Expand All @@ -33,9 +33,9 @@ Install and Run

Errors: if the build errors out (scss syntax errors, incorrect variable names, etc.), the automatic rebuilding process may stop working.

To manually rebuild the site/restart the automatic rebuilding process, press `Ctrl`+`C` and then run `docker-compose up` again.
To manually rebuild the site/restart the automatic rebuilding process, press `Ctrl`+`C` and then run `docker compose up` again.


7. When you are done, press `Ctrl`+`C` and then run `docker-compose down`. Then, optionally:
7. When you are done, press `Ctrl`+`C` and then run `docker compose down`. Then, optionally:
- Docker: quit the Docker app
- Docker Machine/Toolbox: run `docker-machine stop`
4 changes: 4 additions & 0 deletions app/glossary.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ <h2>Frequently Asked Questions</h2>

<ul class="toc-level-2">
<li><a href="#search">How can I search the H2O collection?</a></li>
<li><a href="#cases">What cases does H2O have access to?</a></li>
<li><a href="#verified-professor">What does it mean to be a Verified Professor?</a></li>
<li><a href="#who-can-view">Who can view my casebooks?</a></li>
<li><a href="#adaptation-credit">How do I give credit to folks whose book I adapted?</a></li>
Expand All @@ -32,6 +33,9 @@ <h2>Frequently Asked Questions</h2>
<h3 id="search">How can I search the H2O collection?</h3>
<p>Anybody can search the H2O collection - users do not have to be logged in to do so*. Simply click the <a href="https://opencasebook.org/search/">Search Casebooks</a> button at the top of the H2O website. Once you’ve arrived at the H2O Casebook Collection, use the search window and drop-down filters to find resources you can use.
<p>* Note that if you want to clone or take notes on a book that you find, you do need to be logged in.</p>

<h3 id="cases">What cases does H2O have access to?</h3>
<p>As of August 2024, H2O now has access to new and up-to-date cases via <a href="https://www.courtlistener.com/" target="_blank">CourtListener</a> and the <a href="https://case.law" target="_blank">Caselaw Access Project (CAP)</a>. CourtListener has all 6.5M+ cases from the Library Innovation Lab's Caselaw Access Project, which covers cases from 1658 to 2018, as well as millions of more recent or unpublished decisions collected directly from court websites. When you use H2O, you'll now automatically get cases from this larger and more up-to-date collection. CourtListener is run by the <a href="https://free.law/" target="_blank">Free Law Project</a> - for more information, <a href="https://www.courtlistener.com/help/coverage/" target="_blank">check out their website</a>.</p>

<h3 id="verified-professor">What does it mean to be a Verified Professor?</h3>
<p>Anybody with an H2O account can create a new casebook for their own purposes, but only casebooks by Verified Professors will show up in the H2O collection and in web searches. Verified Professors also have access to features like teaching notes, image upload and video embedding which are not available to general users. To become a Verified Professor, check the box at the bottom of your <a href="https://opencasebook.org/accounts/edit/">Profile</a> and click Save to send a request to our team.</p>
Expand Down
2 changes: 1 addition & 1 deletion app/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ <h3 id="about">About H2O</h3>
<p>The casebook - annotated collections of court cases - has been a cornerstone of legal education for over 150 years. But casebooks today are heavy, expensive and way too difficult to use.</p>
<p>We believe casebooks can be better for authors and students. Authors should be able to easily create or customize their own casebooks online. And students should be able read the casebooks online or in print for little or no cost.</p>
<p>H2O is a website that helps faculty authors make casebooks that are free, simple to modify, and easy to access and print. H2O is offered by the Harvard Law School Library, through its <a href="https://lil.law.harvard.edu" target="_blank">Library Innovation Lab</a>.</p>
<p>H2O gives authors access to the entire database of U.S. court decisions made available through the <a href="https://case.law" target="_blank">CaseLaw Access Project</a>, another initiative of the Library Innovation Lab. Authors can pull any of those cases into their casebooks, together with their own texts and links to external sources on the web. These casebooks, in turn, are free to access and can be copied, shared and adapted under a <a href="https://creativecommons.org/licenses/by-nc-sa/3.0/" target="_blank">CC BY-NC-SA 3.0 license</a>. In addition, H2Os software is open source and available on <a href="https://github.com/harvard-lil/h2o" target="_blank">Github</a>. </p>
<p>H2O gives authors access to the entire database of U.S. court decisions made available via <a href="https://www.courtlistener.com/" target="_blank">CourtListener</a> and the <a href="https://case.law" target="_blank">Caselaw Access Project</a>. Authors can pull any of those cases into their casebooks, together with their own texts and links to external sources on the web. These casebooks, in turn, are free to access and can be copied, shared and adapted under a <a href="https://creativecommons.org/licenses/by-nc-sa/3.0/" target="_blank">CC BY-NC-SA 3.0 license</a>. In addition, H2O's software is open source and available on <a href="https://github.com/harvard-lil/h2o" target="_blank">Github</a>. </p>

<h3 id="account-set-up">Account set-up</h3>
<p> Anybody with an internet connection can read an H2O casebook - <a href=https://opencasebook.org/search/>browse the collection here</a>. Anybody who wants to author, remix, or take notes on a casebook will need to create an account. If your email address ends in .edu or .gov, you can create an account on our <a href=https://opencasebook.org/accounts/new/> Sign Up page</a>. If you have trouble, please email us at [email protected]. </p>
Expand Down
4 changes: 2 additions & 2 deletions app/making-casebooks.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ <h3 id="quick-add">Quick add</h3>
<p>If you have an outline or a list of items you want to include, you can copy and paste the entire outline into the Quick Add window at the bottom of your casebook. This will ingest those items into your H2O book where you can finalize your entries, add text, and change the order.</p>
<p>If you prefer to build your outline within H2O, or simply want to add items one by one, you can drop single items (case citations, links, heading names) into the Quick Add window.
</p>
<p>You can also use the Quick Add window to grab sections or resources from other H2O books, or to add cases directly from our sister project, the Caselaw Access Project. For H2O resources, simply copy and paste the URL from the resource you want to add to your book and paste it in the Quick add window. For CAP cases, copy and paste the URL of the case you’d like to include and drop it in the Quick add window.</p>
<p>You can also use the Quick Add window to grab sections or resources from other H2O books, or to add cases directly from CourtListener. For H2O resources, simply copy and paste the URL from the resource you want to add to your book and paste it in the Quick add window. </p>

<p>Once you’ve added your resources via Quick Add, any item that needs further attention will be outlined in red. For cases, if H2O is unable to match the given citation or case name, you’ll need to click ‘Specify Case’ and then use the search tool to select the case you want.
</p>
Expand Down Expand Up @@ -277,7 +277,7 @@ <h3 id="add-link">Add link</h3>
</figure>

<h3 id="correction">Correction</h3>
<p>H2O is powered by the Caselaw Access database of over 6M U.S. court opinions. These cases were scanned and run through Optical Character Recognition software to become machine readable. While OCR is a powerful tool, it is not perfect, and you will notice typos in the text of the cases. For the most part, the correct text can be inferred from the context, but if you’d like to “fix” those errors for your students, the Correct tool allows you to do so.</p>
<p>H2O provides access to millions of cases via <a href="https://www.courtlistener.com/" target="_blank">CourtListener</a> and the <a href="https://case.law" target="_blank">Caselaw Access Project</a>, and allows authors to seamlessly integrate these primary legal documents alongside other digital content. These cases were scanned and run through Optical Character Recognition software to become machine readable. While OCR is a powerful tool, it is not perfect, and you will notice typos in the text of the cases. For the most part, the correct text can be inferred from the context, but if you’d like to “fix” those errors for your students, the Correct tool allows you to do so.</p>

<h2 id="arranging-content">Arranging Content</h2>
<h3 id="moving-content">Moving Content</h3>
Expand Down
2 changes: 1 addition & 1 deletion scripts/run-tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ validate_frontmatter () {

if validate_frontmatter
then
docker-compose run jekyll jekyll build --trace
docker compose run jekyll jekyll build --trace
java -jar node_modules/vnu-jar/build/dist/vnu.jar --skip-non-html --errors-only --filterfile tests/config/vnufilter.txt build/
echo "$(find ./build -type f -name "*.html" | wc -l) files validated"
else
Expand Down
Loading