Skip to content
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
2 changes: 1 addition & 1 deletion docs/get_started/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To join the community, just [email us](mailto:litlab@suffolk.edu)!
## Get involved/support our work

- We offer affordable Docassemble hosting and e-filing tools for courts and legal aid organizations. Interested? [Email us!](mailto:litlab@suffolk.edu)
- We need [volunteers](volunteer.mdx) to help update, test, and translate interviews. We also need volunteers to help us organize volunteers.
- We need [volunteers](/docs/volunteer/volunteer.mdx) to help update, test, and translate interviews. We also need volunteers to help us organize volunteers.
- We also accept [donations](https://www.givecampus.com/campaigns/70271/donations/new) to help us continue developing these free and open-source tools.

## Our code
Expand Down
9 changes: 5 additions & 4 deletions docs/react_components/VolunteerFormLink.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ export function VolunteerFormLink( props ) {

const { search } = useLocation();
const urlParams = new URLSearchParams( search );
const source = urlParams.get(`source`);
const source = props.source || urlParams.get(`source`);

let sign_up_text = `Sign up to express your interest`
if ( source ) {
sign_up_text = `Sign up to volunteer`
}

return (<a
return (<div><button
className={`button button--primary ${ props.className }`}
target="_blank"
// disabled={ source == null }
// disabled={ props.disabled }
style={{
"--ifm-button-size-multiplier": "1.25",
fontWeight: "normal",
Expand All @@ -30,6 +30,7 @@ export function VolunteerFormLink( props ) {
}>
{ sign_up_text }
<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" className="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg>
</a>)
</button></div>
)

};
138 changes: 138 additions & 0 deletions docs/volunteer/flows.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
---
id: volunteer_flows
title: Volunteer flows
sidebar_label: Workflows
slug: flows
---

import { VolunteerFormLink } from '/docs/react_components/VolunteerFormLink.jsx';

Welcome organizers, this page is for the flows different crews of volunteers go through at different stages of their participation. For everyone else, we'd love to have you on board too, so come sign up!

<VolunteerFormLink source="docsresources"/>

<br />

<details open="true">
<summary>All</summary>

## Group intro sessions

1. Schedule 2 intro sessions at different times of the week/day.
1. Send email to new participants with:
- an invitation to Microsoft Teams
- a form to fill out their availability for those 2 intro session options (or neither)
1. Run the intro sessions.
1. Introduce organizers and volunteers.
1. Describe the current program and goals with visuals:
- https://courtformsonline.org/
1. Link to the community agreement doc.
1. Describe expectations.
1. Give venues for check-in.
1. Give schedule for meetings and office hours.
1. Ideally guide interested folks while they log onto Teams and join the `#Volunteers` channel.
1. Arrange for the next point of contact.
1. Answer questions.
1. Follow up with those who missed both sessions.
1. Update the volunteer tracker.

</details>


<details open="true">
<summary>Organizers</summary>

## Organizers start

Join the Microsoft Teams `#Volunteer Ops` channel.

</details>


<!--
## Legal subject matter experts
-->


<details open="true">
<summary>Builders</summary>

## Builders start

1. [Register for a LIT Lab Docassemble server account](https://apps-dev.suffolklitlab.org/user/register) on the development server. You will then be a regular user. Use your registration email address to [email us](mailto:litlab@suffolk.edu "mailto:litlab@suffolk.edu") a request for a developer account. Remember to include some context about yourself.
1. If you have a GitHub account, log into your GitHub account. If you lack a GitHub account, make one:
1. Choose a GitHub username. If you want more privacy, choose a name that is unrelated to you and unrelated to anyone and anything in your life.
1. [Make the GitHub account](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home).
1. If you want to increase privacy, set [your GitHub account's email settings](https://github.com/settings/emails) to keep your email private and choose to block pushes that expose your email.
1. Go to [your GitHub integration page on the LIT Lab Docassemble server](https://apps-dev.suffolklitlab.org/github_menu) and authorize your GitHub account.
1. Attend training sessions. [Builder training session resources are here](https://docassemble.org/docs/volunteer/resources.html#training).
1. Complete the final project.
1. Ask an organizer to add you to the LIT Lab GitHub organization volunteer team.

## Builders first issue

_You will do one starter issue as an introduction to LIT Lab's GitHub workflow._

When you are first starting to learn to build forms, it is often hard to judge the level of difficulty of an issue. The DAL crew tries to identify good issues for people new to the project, but we are sometimes wrong.

1. Search for [a starter issue in LIT Lab's GitHub repositories](https://github.com/search?q=org%3ASuffolkLITLab+is%3Aissue+label%3Astarter+is%3Aopen&type=issues). The DAL crew tries to pick out good starter issues, but sometimes we miss the mark.
1. Check if this issue looks like it is about a typo.
1. If you think the issue is about a typo, definitely continue.
1. If the issue is about something else, decide if it is a good match for your level of experience. If you are unsure, ask a more experienced member of the Builder crew. Michelle is good resource for this. If you decide to take on the issue, continue. Otherwise, look for another issue.
1. Check if the issue is still up to date. Some may have been fixed without being closed or irrelevant for some other reason. If the issue should be closed, write a comment about why it can be closed and close the issue. Look for a different issue.
1. Assign yourself to the issue.
1. If the issue is comfortable, here is a summary of the GitHub workflow. It is very similar to [the process that training module 3 describes](https://youtu.be/JpOaS8YeMvc?list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5&t=2658).
1. Make a new Project on the docassemble server.
1. Pull the code from GitHub into your new Project.
1. Make the changes necessary to resolve the issue and no more.
1. Run the form.
1. If there is a problem, edit and run the form again. Repeat until complete.
1. Go to the Project's Packages page.
1. Press the "GitHub" button, choose to make a new branch, add a commit message that is a good reminder of what you did, and press "Commit".
1. On GitHub, make a pull request with that branch.
1. In the main comment of the pull request, write `Closes #` and then the issue number. For example, `Closes #42`.
1. Still in the main comment, describe the changes you made in your code and why.
1. Request a review from `@SuffolkLITLab/dal-reviewers`
</details>


<!--
## Translators
-->


<!--
## Others
Depends on the activity.
-->


<!--
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

## By volunteer team

<Tabs groupId="crew">
<TabItem value="organizers" label="Organizers" default>
1. Join the Microsoft Teams `#Volunteer Ops` channel.
</TabItem>
<TabItem value="smes" label="Subject matter experts">
TBD
</TabItem>
<TabItem value="builders" label="Builders">
1. [Register for a LIT Lab Docassemble server account](https://apps-dev.suffolklitlab.org/user/register) on the development server. You will then be a regular user. Use your registration email address to [email us](mailto:litlab@suffolk.edu "mailto:litlab@suffolk.edu") a request for a developer account. Remember to include some context about yourself.
1. If you have a GitHub account, log into your GitHub account. If you lack a GitHub account, make one:
1. Choose a GitHub username. If you want more privacy, choose a name that is unrelated to you and unrelated to anyone and anything in your life.
1. [Make the GitHub account](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home).
1. If you want to increase privacy, set [your GitHub account's email settings](https://github.com/settings/emails) to keep your email private and choose to block pushes that expose your email.
1. Go to [your GitHub integration page on the LIT Lab Docassemble server](https://apps-dev.suffolklitlab.org/github_menu) and authorize your GitHub account.
</TabItem>
<TabItem value="translators" label="Translators">
TBD
</TabItem>
<TabItem value="others" label="Others">
TBD
</TabItem>
</Tabs>
-->
133 changes: 133 additions & 0 deletions docs/volunteer/resources.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
---
id: volunteer_resources
title: Volunteer resources
sidebar_label: Resources
slug: resources
---

import { VolunteerFormLink } from '/docs/react_components/VolunteerFormLink.jsx';

Welcome volunteer, these resources may be of help. For everyone else, we'd love to have you on board too, so come sign up!

<VolunteerFormLink source="docsresources"/>

## General

### Contacts

Find us on Microsoft Teams!

**Volunteer organizers:** Michelle, JJ, Chris<br />
**LIT Lab staff:** Sam, Quinten


### Links

- [LIT Lab Docassemble development server](https://apps-dev.suffolklitlab.org/)
- [LIT Lab GitHub organization](https://github.com/SuffolkLITLab/)
- [Docassemble slack](https://docassemble.org/docs/support.html#slack)

<!--
- Paste-able general project blurb:
Blurb for people to copy into messages and emails goes here.
-->

### Current projects {#projects_general}

- [US states and territories Delegation of Parental Rights forms GitHub project](https://github.com/SuffolkLITLab/50StateDelegationOfParentalRights#readme)

<!--
- Paste-able current project blurb:
Blurb for people to copy into messages and emails goes here.
-->

## Organizers


- [Volunteers sign up, intro, and current updates page](./volunteer.mdx)
- [Volunteer signup form link](https://apps.suffolklitlab.org/interview?i=docassemble.DALVolunteerSignup:main.yml&source=resourcesorganizing)
- Scheduling tool proposals:
- https://voteon.date/. Example admin results page: https://voteon.date/EGFdiu/results/6K1dmq.
- https://www.when2meet.com/. Some people find it confusing.
- Contact other organizers to get links for volunteer tracking tools.

<!--
- General paste-able blurb:
Blurb for people to copy into messages and emails goes here.
- Temporary custody project paste-able blurb:
Blurb for people to copy into messages and emails goes here.
- Organizer search paste-able blurb:
Blurb for people to copy into messages and emails goes here.
-->


### Current projects {#projects_ops}

- [GitHub project **board** for US states and territories Delegation of Parental Rights](https://github.com/orgs/SuffolkLITLab/projects/95)


<!--
## Legal subject matter experts

TBD

- GitHub search for SME issues?
- GitHub project board "ready for review" column?
-->


## Builders

### General

- [Register for a LIT Lab Docassemble server account](https://apps-dev.suffolklitlab.org/user/register) on the development server. You will then be a regular user. Use your registration email address to [email us](mailto:litlab@suffolk.edu "mailto:litlab@suffolk.edu") a request for a developer account. Remember to include some context about yourself.
- [LIT Lab docassemble development server general link](https://apps-dev.suffolklitlab.org/).
- [You LIT Lab docassemble Projects](https://apps-dev.suffolklitlab.org/playgroundproject).
- [DAL documentation about PDF labels and variable names](https://assemblyline.suffolklitlab.org/docs/authoring/label_variables).
- [ALWeaver](https://apps-dev.suffolklitlab.org/run/generator) to make first drafts of interviews.
- [Experimental PDF editor](https://nonprofittechy.github.io/pdf-editor-ui/).
- [GitHub how-to's](https://assemblyline.suffolklitlab.org/docs/authoring/github).
- ALKlin automated testing:
- [ALKiln setup](../components/ALKiln/setup.mdx).
- [ALKiln test writing](../components/ALKiln/writing_tests.mdx).
- [ALKiln intro](../components/ALKiln/intro.mdx).
- [Docassemble documentation](https://docassemble.org/docs.html).


### Checkers

- [Text difference checker to compare different versions of text](https://www.diffchecker.com/).
- [Python syntax validator](https://extendsclass.com/python-tester.html).
- No validators found for Mako (Mako is Markdown with variables and python).
- [Quick markdown previewer](https://markdownlivepreview.com/). Can't use variables.
- [YAML validator](https://codebeautify.org/yaml-validator/) as long as you ignore the one error that says "expected a single document in the stream, but found more".
- [**Very** simple Jinja validator](https://www.dainiak.com/jinja2-playground/). Only validates very, very simple Jinja. For example, syntax like `%p` (as in `{%p if True %}`) gets errors.
- [Gherkin syntax validator](https://www.assertthat.com/online-gherkin-editor) for ALKiln tests.


### Training

- [Training module GitHub repository](https://github.com/SuffolkLITLab/docassemble-DALTraining/)
- For reference and diff checking, because cheating is self-defeating, [here are the question files for the different modules](https://github.com/SuffolkLITLab/docassemble-DALTraining/tree/main/docassemble/DALTraining/data/questions).
- [Training module final project instructions](https://github.com/SuffolkLITLab/docassemble-DALTraining/?tab=readme-ov-file#final-project)

1. [Training module 1 on YouTube](https://www.youtube.com/watch?v=XwjDOPxdoJU&list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5&index=1)
1. [Training module 2 on YouTube](https://www.youtube.com/watch?v=ap_XozvLpFk&list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5&index=2)
1. [Training module 3 on YouTube](https://www.youtube.com/watch?v=JpOaS8YeMvc&list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5&index=3)


<!--
### Training module 1

[Training module 1 on YouTube](https://www.youtube.com/watch?v=XwjDOPxdoJU&list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5&index=1)

<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/XwjDOPxdoJU?list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5" title="Document Assembly Line interview builder training, session 01" frameborder="0" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
-->


<!--
## Translating

TBD
-->

Loading
Loading