Skip to content

Commit

Permalink
Remove older things from README, update Griv_view
Browse files Browse the repository at this point in the history
With latest data. Airtable is smarter about putting quotes around everything,
but it shouldn't change our parsing at all.
  • Loading branch information
BryceStevenWilley committed Jun 4, 2022
1 parent 4591e91 commit a161dfe
Show file tree
Hide file tree
Showing 2 changed files with 135 additions and 166 deletions.
47 changes: 7 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@ A docassemble extension that helps a user search for docs in a Google Drive base
Made in association with The [Chancery Lane Project](https://chancerylaneproject.org/)

Special dependencies:

* a branch of [docxcompose](https://github.com/BryceStevenWilley/docxcompose/tree/master), version `1.3.5-devlemma`.
* this branch merges a [standing PR](https://github.com/4teamwork/docxcompose/pull/58) that works when certain styles aren't present
* also fixes some issues with [abstractNumId uniqueness](https://github.com/BryceStevenWilley/docxcompose/commit/a90e445857dbf61ce5c999bb50b13291b51d7b12)
* a branch of [docxtpl](https://github.com/LemmaLegalConsulting/docxtpl/tree/subdoc_bookmark_issues)
* this branch fixed an issue where bookmark ids were only renumbered per subdocument, not over the whole document
* a branch of [docassemble that supports optgroups](https://github.com/BryceStevenWilley/docassemble/tree/optgroups)
* also includes a [PR that prevents DA from crashing on newer versions of docxtpl](https://github.com/jhpyle/docassemble/pull/504), which the previous branch includes

## Airtable Config

Expand All @@ -30,46 +29,15 @@ docs airtable:
If there are issues connecting to the Airtable, those issues will be
printed in the [docassemble logs](https://docassemble.org/docs/admin.html#logs).
## Refreshing the Airtable Data Source.
If Airtable is down or you haven't configured Airtable correctly, this interview will use a CSV backup of the information in the airtable, saved in this repository.
In the rare case that you need to update, you will need to do two things: setting up a way to modify the installed interview on a server, and
actually updating the CSV file. The first step only needs to be done once, per user per server.
### Modifying an installed interview
1. Login to your server. You should have at least developer privileges.
2. Go to the playground (click your email on the top right of the screen to reveal a drop down, then click on "Playground").
![Use the drop down menu on the top right to then get to the playground](assets/get-to-playground.png)
3. Once in the playground, you need to pull the latest version of the code from Github. Click "Folders > packages", then "Pull".
![In the playground screen, press "Folders > packages"](assets/playground-packages.png)
## Google Drive Config
![On the packages screen, press "Pull"](assets/get-to-pull.png)
In your docassemble configuration, you should add the following YAML key-value pair:
4. There, enter the information of this github repo:
* github url: https://github.com/LemmaLegalConsulting/docassemble-tclpgoogledocsmerger
* branch: main
Press pull.
![Enter the information into these screens, then press "Pull".](assets/pull-github.png)
5. Press back (top left of the screen) until you are at the playground screen again.
### Updating the CSV file.
```yaml
drive doc bank: "google-drive-folder-id-abc123"
```
1. Go to the [Airtable with the clause data](https://airtable.com/shr5ITqr8fOECQthj/tblZduZJJkNz9tbzY).
2. Press "download as CSV", hidden behind the three dots. Save the CSV file on your computer as `Grid_view.csv`.
![On the Airtable base, press the three dots, then "Download as CSV"](airtable.png)
3. Go back to your playground on the docassemble server.
4. In the playground, go to "Folders > Sources".
![Go to the sources file with "Folders > sources"](assets/playground-sources.png)
5. On the sources page, upload the `Grid_view.csv` file by pressing "Browse..." and then "Upload".
![The sources screen: upload the CSV file, then press "Upload"](upload-source.png)
6. Press back (top left) to go back to the playground. Then go to "Folders > packages".
![In the playground screen, press "Folders > packages", then "Pull" on the new screen](assets/playground-packages.png)
7. (optional) on this screen, you can update the version. This allows you to easily know what version of the Airtable document
is being used in production. Change the version to anything you like. The default looks like 1.2.3, but you can add text as well, i.e.
1.2.3-march-data. Change this version number and press save at the bottom of the screen.
8. Press "Install" at the bottom of the screen. This will cause the server to restart, so avoid updating during peak traffic times.
The Google drive folder id should be visible in the URL of the drive folder, after `/u/0/folders/`.

## Adding new Clauses

Expand All @@ -88,4 +56,3 @@ remove them from the original documents. That process is described below:
## Authors

Bryce Willey, Quinten Steenhuis

Loading

0 comments on commit a161dfe

Please sign in to comment.