Skip to content

Commit 3560755

Browse files
Change links, remove duplicate content, clean up intro
* Change links to point to the page on this site, instead of the old page * Theming and translating interviews already had pages on this site, merged with them instead * Changed the overview to not point folks to the other site.
1 parent 86c997c commit 3560755

26 files changed

+79
-269
lines changed
File renamed without changes.
File renamed without changes.

docs/admin-guide-docassemble/rebuild-lightsail-instance.md renamed to docs/admin_guide_docassemble/rebuild-lightsail-instance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ the following setup:
3737

3838
It also assumes you can access all those items through AWS, including SSH access to
3939
the Lightsail instance. See
40-
[Installing a docassemble server](https://suffolklitlab.org/legal-tech-class/docs/practical-guide-docassemble/setup-server)
40+
[Installing a docassemble server](setup-server)
4141
for instructions on setting up a server.
4242

4343
It is also important that you make note of your existing admin and developer accounts
@@ -137,7 +137,7 @@ On the new instance:
137137
## Follow instructions on Installing a docassemble server
138138

139139
Most of the remaining steps are the same ones used in the [Finish installation on your Lightsail instance over
140-
SSH](https://suffolklitlab.org/legal-tech-class/docs/practical-guide-docassemble/setup-server#finish-installation-on-your-lightsail-instance-over-ssh)
140+
SSH](setup-server#finish-installation-on-your-lightsail-instance-over-ssh)
141141
section of **Installing a docassemble server**.
142142

143143
Note: When entering the Linux commands in those instructions, it works best to enter them one
File renamed without changes.
File renamed without changes.

docs/admin-guide-docassemble/updates-and-maintenance.md renamed to docs/admin_guide_docassemble/updates-and-maintenance.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@ using your host operating system's package manager.
5959

6060
Docassemble has two parts:
6161

62-
1. a [Python](/docs/python.md) web application, built around the [Flask
62+
1. a [Python](../docassemble_intro/python.md) web application, built around the [Flask
6363
framework](https://flask.palletsprojects.com/en/2.2.x/)
6464
1. An Ubuntu docker image and a series of Linux applications that the web
6565
frontend communicates with, including
66-
- A specific version of [Python](/docs/python.md) (3.10 as of this writing)
66+
- A specific version of [Python](../docassemble_intro/python.md) (3.10 as of this writing)
6767
- [LibreOffice](https://www.libreoffice.org/discover/writer) for converting
6868
Word documents to PDF
6969
- [LaTeX](https://www.latex-project.org/) for assembling
70-
[Markdown](/docs/markdown.md) files
70+
[Markdown](../docassemble_intro/markdown.md) files
7171
- [PDFtk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/) for
7272
manipulating PDF files and templates
7373
- [LetsEncrypt](https://letsencrypt.org/) for SSL certificate management
@@ -254,7 +254,7 @@ sudo shutdown -r now
254254
for a security vulnerability.
255255
- Beyond periodic updates, the version of Ubuntu software may need an upgrade. This is like going from
256256
Windows 10 to 11, or macOS Ventura to Sonoma. Every 2 years, there's a new Ubuntu Long Term Support
257-
(LTS) version. See [Rebuilding your AWS Lightsail instance](https://projects.suffolklitlab.org/legal-tech-class/docs/practical-guide-docassemble/rebuild-lightsail-instance).
257+
(LTS) version. See [Rebuilding your AWS Lightsail instance](rebuild-lightsail-instance).
258258
- What to back up - Keep a copy of the latest env.list file in case a rebuild is required.
259259
- Wnen to back up - After a backup copy of env.list is made, a new backup is needed only if the contents
260260
of that file changes.
@@ -283,7 +283,7 @@ software runs within. Using a virtual machine adds to resiliency, though it also
283283

284284
- How to monitor - Use `docker ps` command to make sure it is running.
285285
- How to update - See
286-
[Updates to the Docassemble container](https://suffolklitlab.org/legal-tech-class/docs/practical-guide-docassemble/maintaining-docassemble#updates-to-the-docassemble-container).
286+
[Updates to the Docassemble container](maintaining-docassemble#updates-to-the-docassemble-container).
287287
You will use these commands: `docker stop, pull, run,` and `prune`.
288288
- If you [updated the nginx timeout to 5 minutes](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation/#increase-nginx-timeouts-to-5-minutes)
289289
earlier, you will need to redo it.
@@ -299,7 +299,7 @@ Playground.
299299
- How to monitor - If you can get to the Playground, My Interviews, or an individual program, then it's working.
300300
[UptimeRobot](https://uptimerobot.com/) can be used to receive server up/down notifications by email.
301301
- How to update - Log in as an administrator. Go to Package Management. Click the "Upgrade" button. See
302-
[Updates to the Docassemble frontend](https://suffolklitlab.org/legal-tech-class/docs/practical-guide-docassemble/maintaining-docassemble#updates-to-the-docassemble-frontend)
302+
[Updates to the Docassemble frontend](maintaining-docassemble#updates-to-the-docassemble-frontend)
303303
- When to update - Every few weeks or as needed if there is a critical bug fix or a desired new feature.
304304

305305
### Packages
@@ -308,10 +308,9 @@ These are the program code, frameworks, and utilities that run on the Docassembl
308308
is an example used by many programs.
309309
- How to monitor - Monitors like [httpstatus.io](https://httpstatus.io/) or homegrown programs can check if individual
310310
programs are running. Note: These tools just check whether individual interview pages are reachable. Learn about using
311-
[ALKiln](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/) to do automated
311+
[ALKiln](../components/ALKiln/alkiln) to do automated
312312
start-to-finish testing and monitoring.
313-
- How to update - You can
314-
[update Assembly Line packages individually](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/),
315-
or you can use the [ALDashboard](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/).
313+
- How to update - You can update Assembly Line packages individually,
314+
or you can use the [ALDashboard](../components/ALDashboard/overview)
316315
You can also update individual packages on the Package Management screen.
317316
- When to update - Every few weeks or as needed if there is a critical bug fix or a desired new feature.

docs/archive/bootcamp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ If you are finding this page after February 18th, 2021, be sure to watch the vid
2929
Read:
3030

3131
1. If you are unfamiliar with the Assembly Line project, please give the [intro page](../get_started) a look
32-
1. Read over this short [introduction to Docassemble](https://suffolklitlab.org/legal-tech-class/docs/introduction-to-docassemble)
33-
1. And if you want more context, consider reading [what should you use Docassemble for?](https://suffolklitlab.org/legal-tech-class/docs/practical-guide-docassemble/practical-guide-docassemble)
32+
1. Read over this short [introduction to Docassemble](../docassemble_intro/introduction-to-docassemble)
33+
1. And if you want more context, consider reading [what should you use Docassemble for?](../docassemble_intro/practical-guide-docassemble)
3434

3535
Do:
3636

3737
After signing up, you should have received invites to our docassemble server (https://apps-dev.suffolklitlab.org) and [our MS TEAMS group](https://teams.microsoft.com/l/channel/19%3a143ac652e7f1494aacda1f6793b21ccc%40thread.tacv2/bootcamp?groupId=eaa9bd9d-cf39-4686-8f30-e55aa9d98c75&tenantId=78733fa9-540e-4eb8-bf29-73c4eeb63412).
3838

3939
1. Confirm that you can access the docassemble server and your developer account at https://apps-dev.suffolklitlab.org
4040
1. Confirm that you can access the [Suffolk LIT Lab Teams group](https://teams.microsoft.com/l/channel/19%3a143ac652e7f1494aacda1f6793b21ccc%40thread.tacv2/bootcamp?groupId=eaa9bd9d-cf39-4686-8f30-e55aa9d98c75&tenantId=78733fa9-540e-4eb8-bf29-73c4eeb63412)
41-
1. **Optional:** Work through this [Hello, World](https://suffolklitlab.org/legal-tech-class/docs/classes/docacon-2020/hello-world) exercise making use of your developer account. NOTE: this may be challenging for those of you without prior programing experience. You will **NOT** be behind if you can't do it all on your own. Use the [#coding-help](https://teams.microsoft.com/l/channel/19%3ae16e9e9701a5445ea4035b5cb776a4cc%40thread.tacv2/coding-help?groupId=eaa9bd9d-cf39-4686-8f30-e55aa9d98c75&tenantId=78733fa9-540e-4eb8-bf29-73c4eeb63412) channel on Teams if you are stuck and want help.
41+
1. **Optional:** Work through this [Hello, World](../docassemble_intro/hello-world) exercise making use of your developer account. NOTE: this may be challenging for those of you without prior programing experience. You will **NOT** be behind if you can't do it all on your own. Use the [#coding-help](https://teams.microsoft.com/l/channel/19%3ae16e9e9701a5445ea4035b5cb776a4cc%40thread.tacv2/coding-help?groupId=eaa9bd9d-cf39-4686-8f30-e55aa9d98c75&tenantId=78733fa9-540e-4eb8-bf29-73c4eeb63412) channel on Teams if you are stuck and want help.
4242

4343
### Week 1: Introduction and getting started using the Assembly Line interview Weaver, 2/18/2021
4444

docs/authoring/customizing_interview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ slug: customizing_interview
99

1010
While the Weaver is a menu-driven, step-by-step process, you'll make further
1111
edits in the Playground. In the playground, you can directly edit the
12-
[YAML](https://suffolklitlab.org/legal-tech-class/docs/yaml) text to:
12+
[YAML](../docassemble_intro/yaml) text to:
1313

1414
1. Change the wording of questions
1515
1. Change the datatype of questions and add show/hide logic
@@ -22,7 +22,7 @@ many changes can be understood by reading the text and then experimenting.
2222

2323
This pages offers information about making some common, simple edits.
2424
You may also want to take this time to read through the materials in
25-
the [Legal Tech Class](https://suffolklitlab.org/legal-tech-class/docs/introduction-to-docassemble)
25+
[Introduction to Docassemble](../docassemble_intro/introduction-to-docassemble)
2626
about the underlying Docassemble platform and how it works.
2727

2828
## Double-check that you got things right in the Weaver stage
@@ -135,7 +135,7 @@ you get the name of the user, you would simply switch the order of those 2 lines
135135

136136
:::note Learn more about interview order
137137
This section mentions a bit about interview order, but if you want to learn more,
138-
you can read it on the [Legal Tech Class](https://suffolklitlab.org/legal-tech-class/docs/practical-guide-docassemble/controlling-interview-order) site.
138+
you can read it on the [Legal Tech Class](../docassemble_intro/controlling-interview-order) site.
139139
:::
140140

141141
### Order is usually determined by the first variable on the screen

docs/authoring/docx_templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Microsoft Word document, surrounded by two sets of curly braces, like: `{{ varia
4646

4747
The syntax to type in fields in a DOCX template is named `jinja2`.
4848

49-
[Learn more about Jinja2](https://suffolklitlab.org/legal-tech-class/docs/jinja2)
49+
[Learn more about Jinja2](../docassemble_intro/jinja2)
5050
and about [DOCX templates in Docassemble](https://docassemble.org/docs/documents.html#docx%20template%20file).
5151

5252

docs/coding_style/yaml.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ slug: yaml
66
---
77

88
Docassemble interviews are written in
9-
[YAML](https://suffolklitlab.org/legal-tech-class/docs/yaml).
9+
[YAML](../docassemble_intro/yaml).
1010

1111
They may also contain:
1212

@@ -121,7 +121,7 @@ you should never put a `mandatory` block in the files for each individual docume
121121

122122
To group logic that you might want to run with the template it relates to, without making it mandatory:
123123

124-
1. use the [`named block` pattern](https://suffolklitlab.org/legal-tech-class/docs/practical-guide-docassemble/controlling-interview-order#triggering-code-and-then-continuing-using-named-blocks) for the `interview order` block
124+
1. use the [`named block` pattern](../docassemble_intro/controlling-interview-order#triggering-code-and-then-continuing-using-named-blocks) for the `interview order` block
125125
1. reference your `named block` in a mandatory block inside the `main` file that users will run.
126126

127127
While in the development phase, you might want to temporarily test a single document at a time.

0 commit comments

Comments
 (0)