feat(help): apply updated design to Bulk Data page #5853
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Applied the new visual design to the Bulk Data page (`v2_bulk-data.html`) This update ensures consistent layout and styling with other API help pages, following the latest design system. Refs: freelawproject#5353
nazarbodak221
changed the title
Adds an attention-grabbing comment to the old version of the template.
for more information, see https://pre-commit.ci
elisa-a-v
requested changes
Jul 14, 2025
|
|
||
| <c-layout-with-navigation.section id="formats"> | ||
| <h2>Data Format and Field Definitions</h2> | ||
| <p>Files are generated using the PostgreSQL <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html"><code>COPY TO</code></a> command. This generates CSV files that correspond with the tables in our database. Files are provided using the CSV output format, in the UTF-8 encoding, with a header row on the top. If you are using PostgreSQL, the easiest way to import these files is to use the <code>COPY FROM</code> command. Details about the CSVs we generate can be found in the <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html">COPY documentation</a> or by reading <a class="underline" href="https://github.com/freelawproject/courtlistener/blob/main/scripts/make_bulk_data.sh">the code we use to generate these files</a>. You can import the data using <code>COPY FROM</code> by executing a sql statement like this:</p> |
There was a problem hiding this comment.
This link isn't super noticeable:
I think we can make it easier to spot by extending the anchor tag a little bit:
Suggested change
| <p>Files are generated using the PostgreSQL <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html"><code>COPY TO</code></a> command. This generates CSV files that correspond with the tables in our database. Files are provided using the CSV output format, in the UTF-8 encoding, with a header row on the top. If you are using PostgreSQL, the easiest way to import these files is to use the <code>COPY FROM</code> command. Details about the CSVs we generate can be found in the <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html">COPY documentation</a> or by reading <a class="underline" href="https://github.com/freelawproject/courtlistener/blob/main/scripts/make_bulk_data.sh">the code we use to generate these files</a>. You can import the data using <code>COPY FROM</code> by executing a sql statement like this:</p> | |
| <p>Files are generated using the <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html">PostgreSQL <code>COPY TO</code> command</a>. This generates CSV files that correspond with the tables in our database. Files are provided using the CSV output format, in the UTF-8 encoding, with a header row on the top. If you are using PostgreSQL, the easiest way to import these files is to use the <code>COPY FROM</code> command. Details about the CSVs we generate can be found in the <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html">COPY documentation</a> or by reading <a class="underline" href="https://github.com/freelawproject/courtlistener/blob/main/scripts/make_bulk_data.sh">the code we use to generate these files</a>. You can import the data using <code>COPY FROM</code> by executing a sql statement like this:</p> |
|
|
||
| <c-layout-with-navigation.section id="formats"> | ||
| <h2>Data Format and Field Definitions</h2> | ||
| <p>Files are generated using the PostgreSQL <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html"><code>COPY TO</code></a> command. This generates CSV files that correspond with the tables in our database. Files are provided using the CSV output format, in the UTF-8 encoding, with a header row on the top. If you are using PostgreSQL, the easiest way to import these files is to use the <code>COPY FROM</code> command. Details about the CSVs we generate can be found in the <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html">COPY documentation</a> or by reading <a class="underline" href="https://github.com/freelawproject/courtlistener/blob/main/scripts/make_bulk_data.sh">the code we use to generate these files</a>. You can import the data using <code>COPY FROM</code> by executing a sql statement like this:</p> |
There was a problem hiding this comment.
Details about the CSVs we generate can be found in the COPY documentation
This is the same as the live version, but I wonder if the link/wording is correct here. @mlissner do we really want to direct people to the PostgreSQL docs for details about the CSVs we generate? That doesn't sound right to me, but I may be missing something 🤔
There was a problem hiding this comment.
Yeah, we don't provide the highest level of service for these files. It's OK for now.
There was a problem hiding this comment.
So we'll leave it at that for now?
There was a problem hiding this comment.
In that case I still suggest we simply remove that link, it's confusing and we already link to the same docs in a much clearer way at the beginning of the same paragraph.
I think this works much better:
Suggested change
| <p>Files are generated using the PostgreSQL <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html"><code>COPY TO</code></a> command. This generates CSV files that correspond with the tables in our database. Files are provided using the CSV output format, in the UTF-8 encoding, with a header row on the top. If you are using PostgreSQL, the easiest way to import these files is to use the <code>COPY FROM</code> command. Details about the CSVs we generate can be found in the <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html">COPY documentation</a> or by reading <a class="underline" href="https://github.com/freelawproject/courtlistener/blob/main/scripts/make_bulk_data.sh">the code we use to generate these files</a>. You can import the data using <code>COPY FROM</code> by executing a sql statement like this:</p> | |
| <p>Files are generated using the <a class="underline" href="https://www.postgresql.org/docs/current/sql-copy.html">PostgreSQL <code>COPY TO</code> command</a>. This generates CSV files that correspond with the tables in our database. Files are provided using the CSV output format, in the UTF-8 encoding, with a header row on the top. If you are using PostgreSQL, the easiest way to import these files is to use the <code>COPY FROM</code> command. Details about the CSVs we generate can be found in <a class="underline" href="https://github.com/freelawproject/courtlistener/blob/main/scripts/make_bulk_data.sh">the code we use to generate these files</a>.</p> | |
| <p>You can import the data using <code>COPY FROM</code> by executing a sql statement like this:</p> |
Goes from:
To:
| <p><strong>2024-08-02</strong>: Add new fields to the bulk data files for the Docket object: federal_dn_case_type, federal_dn_office_code, federal_dn_judge_initials_assigned, federal_dn_judge_initials_referred, federal_defendant_number, parent_docket_id.</p> | ||
| <p><strong>2023-09-26</strong>: Bulk script refactored to make it easier to maintain. Courthouse table added to bulk script. Court appeals_to through table added to bulk script. Bulk script now automatically generates a shell script to load bulk data and stream the script to S3.</p> | ||
| <p><strong>2023-07-07</strong>: We added the <code>FORCE_QUOTE *</code> option to our export script so that null can be distinguished from blank values. In the past, both appeared in the CSVs as commas with nothing between them (<code>,,</code>). With this change, blanks will use quotes: (<code>,"",</code>), while nulls will remain as before. This should make the <code>COPY TO</code> commands work better. In addition, several missing columns are added to the bulk data to align our exports more closely with our database.</p> | ||
| <p>This is the third version of our bulk data system. Previous versions were available by jurisdiction, by day, month, or year, and in JSON format corresponding to our REST API. We also previously provided our CiteGeist data file. Each of these features has been removed in an effort to simply the feature. For more information, see <a class="underline" href="https://github.com/freelawproject/courtlistener/issues/285">here (removing day/month/year files)</a> and <a class="underline" href="https://github.com/freelawproject/courtlistener/issues/1983">here (removing the JSON format and switching to PostgreSQL dumps)</a>.</p> |
There was a problem hiding this comment.
For accessibility, links should be descriptive enough as standalone elements, so what do you say we change the text here?
Suggested change
| <p>This is the third version of our bulk data system. Previous versions were available by jurisdiction, by day, month, or year, and in JSON format corresponding to our REST API. We also previously provided our CiteGeist data file. Each of these features has been removed in an effort to simply the feature. For more information, see <a class="underline" href="https://github.com/freelawproject/courtlistener/issues/285">here (removing day/month/year files)</a> and <a class="underline" href="https://github.com/freelawproject/courtlistener/issues/1983">here (removing the JSON format and switching to PostgreSQL dumps)</a>.</p> | |
| <p>This is the third version of our bulk data system. Previous versions were available by jurisdiction, by day, month, or year, and in JSON format corresponding to our REST API. We also previously provided our CiteGeist data file. Each of these features has been removed in an effort to simply the feature. For more information, please refer to <a class="underline" href="https://github.com/freelawproject/courtlistener/issues/285">GitHub issue #285 (removing day/month/year files)</a> and <a class="underline" href="https://github.com/freelawproject/courtlistener/issues/1983">GitHub issue #1983 (removing JSON format and switching to PostgreSQL dumps)</a>.</p> |
How does that sound @mlissner ?
Before:
After:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Applied the new visual design to the Bulk Data page (
v2_bulk-data.html)This update ensures consistent layout and styling with other API help pages, following the latest design system.
Screenshot of updated design:
Refs: #5353