diff --git a/docs/get_started/project_management.md b/docs/get_started/project_management.md index bd34b51a1..66e64a040 100644 --- a/docs/get_started/project_management.md +++ b/docs/get_started/project_management.md @@ -14,7 +14,7 @@ Interview-building project generally follows these phases: | Phase | Primary goal | | :------------------------------ | :-------------------- | -| [Kickoff](#kickoff) | See [sample agenda](#kickoff:~:text=Sample%20kickoff%20meeting%20agenda) | +| [Kickoff](#kickoff) | See [sample agenda](#sample-kickoff-agenda) | | [Research](#research) | Gain insight into and understanding of the problem to be solved | | [Design](#design) | Agree on the project requirements\/MVP | | [Development](#development) | Build the interview | @@ -39,7 +39,7 @@ Hold a kickoff meeting for the project as early as possible. Everyone who is imp The goal of a kickoff meeting is to get everyone on the same page when it comes to roles, expectations, and timeline. A good kickoff meeting sets the stage for a successful project. -
+
Sample kickoff meeting agenda * Introductions @@ -213,7 +213,7 @@ To use the project template: 2. Issues will be closed automatically when the card is moved to the **Done** column 3. As you work on your interview, follow the [GitHub workflow](../authoring/github.md#workflow) and move issues/cards from left to right -You can also find a [beginner's guide](beginners_guide.md), [interview-builder resources](resources.md), and [extensive documentation](../overview.md) elsewhere on this website. +You can also find a [beginner's guide](beginners_guide.md), [interview-builder resources](resources.mdx), and [extensive documentation](../overview.md) elsewhere on this website. ### Feedback {#feedback} diff --git a/docs/get_started/resources.md b/docs/get_started/resources.md deleted file mode 100644 index d8c49180f..000000000 --- a/docs/get_started/resources.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -id: resources -title: Interview Building Resources -sidebar_label: Resources -slug: resources ---- - -As you are building interviews, use these resources to find answers to your questions, solve problems you run into, and get help. - -:::tip -If you have been stuck on something for longer than 20 minutes, it's probably time to ask for help. Post a question in the **Coding Help** channel in Teams or bring it to our Monday meeting. - -When you ask for help: - -* Give details -* Share the code you are stuck on -* Share any error messages you may be getting -::: - -## Community Resources - -Docassemble and the Document Assembly Line tools are open-source, which means they are built, maintained, used, and supported by a community of contributors. The Document Assembly Line is a community of courts and legal aid organizations who are building Docassemble interviews. - -### Document Assembly Line - -* Weekly interview builder meetings -* Community forum -* Monthly workshops - -[Email us](mailto:litlab@suffolk.edu) to join! - -
- 📺 First Wednesday Workshops - - Every first Wednesday of the month at 3 PM Eastern, the Suffolk LIT Lab hosts interactive online workshops. These sessions are informal and centered around community questions and requests. - - **Popular workshop topics include:** - - - Docassemble fundamentals and best practices - - Advanced Assembly Line features - - Form automation techniques - - PDF and DOCX template creation - - Testing and debugging interviews - - E-filing integration - - Accessibility and user experience design - - **How to participate:** - - All workshops are free and open to the community - - Sessions are streamed live and recorded for later viewing - - Bring your questions! These are interactive sessions - - [View archived workshops](https://suffolklitlab.org/tag/first-wednesday-workshops/) - - [📅 Browse all workshop recordings →](https://suffolklitlab.org/tag/first-wednesday-workshops/) - -
- -### Docassemble - -* [Slack group](https://join.slack.com/t/docassemble/shared_invite/zt-2cspzjo9j-YyE7SrLmi5muAvnPv~Bz~A) -* [Email list](https://mail.python.org/mm3/mailman3/lists/docassemble.python.org/) - -## Documentation - -While building interviews you will most likely have one or more documentation websites ("docs") open at all times. And when you ask for help in one of the community resources, above, you will often receive a link to documentation as part of a response. This is generally meant to be helpful, not as a way to say "[RTFM](https://en.wikipedia.org/wiki/RTFM)." - -These are the essential documentation websites to have on hand: - -* [This website](/) -* [Docassemble docs](https://docassemble.org/docs.html) - -Docassemble interview files use several kinds of markup. Most of what you will need to know is included on the [Docassemble markup page](https://docassemble.org/docs/markup.html), but sometimes you may need to go to the source for more detailed documentation. - -* [YAML](https://yaml.org/spec/1.2/spec.html) (the base file format) -* [Markdown](https://daringfireball.net/projects/markdown/) (formatting text) -* [Mako](https://docs.makotemplates.org/en/latest/) (using variables and code within questions) -* [Python](https://docs.python.org/3/reference/index.html) (coding in Mako tags and [code blocks](https://docassemble.org/docs/code.html)) -* [Jinja](https://jinja.palletsprojects.com/en/3.0.x/) (used in [DOCX templates](../authoring/docx_templates.md)) - -You can also use [HTML](https://docassemble.org/docs/markup.html#markdownhtml), [CSS](https://docassemble.org/docs/ui.html#css), and [Javascript](https://docassemble.org/docs/initial.html#javascript) in Docassemble interviews. - -* [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) (advanced formatting) -* [CSS](https://developer.mozilla.org/en/docs/Web/CSS/Reference) (customizing the UI) -* [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) and [jQuery](https://api.jquery.com/) (advanced customization) - -:::info JavaScript Workshop Resource -📺 **First Wednesday Workshop:** For practical guidance on integrating JavaScript into your Docassemble interviews, watch our workshop [Using JavaScript in Docassemble](https://suffolklitlab.org/using-javascript-in-docassemble/). This session covers common JavaScript patterns, jQuery integration, and best practices for enhancing interview functionality. -::: \ No newline at end of file diff --git a/docs/get_started/resources.mdx b/docs/get_started/resources.mdx new file mode 100644 index 000000000..bda482307 --- /dev/null +++ b/docs/get_started/resources.mdx @@ -0,0 +1,149 @@ +--- +id: resources +title: Resources +sidebar_label: Resources +slug: resources +--- + +import { VolunteerFormLink } from '/docs/react_components/VolunteerFormLink.jsx'; + +As you are building interviews, use these resources to find answers to your questions, solve problems you run into, and get help. + +## Community hub + +Microsoft Teams is our community hub. You can find channels for general communication, coding help, governance, off-topic chat, and more. To join the Document Assembly Line in Teams, just [email us](mailto:litlab@suffolk.edu?subject=Request%20to%20join%20Teams)! + +If you've already joined us in Teams: + +Go to Teams + +## Interview building resources + +:::info +In order to build Docassemble interviews you will need access to a Docassemble development server. The LIT Lab has a shared dev server for our students, our [court and legal aid partners](/#partners) (current and prospective), and [Document Assembly Line volunteers](/docs/volunteer/sign_up). If you are a partner or volunteer, use [this workflow](/docs/volunteer/flows#dev-server) to get access to the LIT Lab dev server. + +Otherwise, you'll need to [set up your own Docassemble server](https://docassemble.org/docs/installation.html). It looks intimidating, but it's not too hard! If you run into problems, you can ask for help in the [**Server admin** channel](https://teams.microsoft.com/l/channel/19%3Ad8d78c13648140308a2cc1670a4fdd06%40thread.tacv2/Server%20admin?groupId=eaa9bd9d-cf39-4686-8f30-e55aa9d98c75&tenantId=78733fa9-540e-4eb8-bf29-73c4eeb63412) in Teams. +::: + +### Training + +Once you have access to a dev server, you can follow along with our free [interview builder training videos](https://www.youtube.com/watch?v=XwjDOPxdoJU&list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5). You will also need the [training materials](https://github.com/SuffolkLITLab/docassemble-DALTraining), which include [question files](https://github.com/SuffolkLITLab/docassemble-DALTraining/tree/main/docassemble/DALTraining/data/questions) for the sessions (for reference and diff checking, because cheating is self-defeating). + +Individual training sessions: + +- [Session #1](https://www.youtube.com/watch?v=XwjDOPxdoJU&list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5&index=1) +- [Session #2](https://www.youtube.com/watch?v=ap_XozvLpFk&list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5&index=2) +- [Session #3](https://www.youtube.com/watch?v=JpOaS8YeMvc&list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5&index=3) +- [Final project instructions](https://github.com/SuffolkLITLab/docassemble-DALTraining/?tab=readme-ov-file#final-project) + +:::tip +📺 The LIT Lab hosts monthly workshops based on community questions and requests. + +- [View recorded workshops](https://suffolklitlab.org/tag/first-wednesday-workshops/) +- [Register for future workshops](https://suffolk.zoom.us/meeting/register/tJAsce-oqTorGd3QACxQDBwGGGnVK8tehTaV) +::: + +### Using AssemblyLine tools + +#### ALWeaver (generating draft interviews from existing PDF/DOCX forms) + +- [DAL documentation about PDF labels and variable names](https://assemblyline.suffolklitlab.org/docs/authoring/label_variables) +- [Experimental PDF editor](https://nonprofittechy.github.io/pdf-editor-ui/) +- [ALWeaver](https://apps-dev.suffolklitlab.org/run/generator) + +#### ALKiln (testing suite for Docassemble interviews) + +- [Intro](../components/ALKiln/intro.mdx) +- [Setup](../components/ALKiln/setup.mdx) +- [Test writing](../components/ALKiln/writing_tests.mdx) + +### Coding help + +If you are stuck on something for longer than 20 minutes, it's probably time to ask for help! + +- Seek help in the [**Coding help** channel](https://teams.microsoft.com/l/channel/19%3Ae16e9e9701a5445ea4035b5cb776a4cc%40thread.tacv2/Coding%20help?groupId=eaa9bd9d-cf39-4686-8f30-e55aa9d98c75&tenantId=78733fa9-540e-4eb8-bf29-73c4eeb63412) in Teams +- Come to our [weekly community standups](https://suffolk.zoom.us/j/95053079942), Michelle's office hours, or our other [community meetings](https://sumail.sharepoint.com/:b:/r/sites/LegalInnovationandTechnologyLab/Shared%20Documents/General/DAL%20community%20meetings.pdf?csf=1&web=1&e=a3eLL9) +- Ask in the [Docassemble Slack group](https://join.slack.com/t/docassemble/shared_invite/zt-2cspzjo9j-YyE7SrLmi5muAvnPv~Bz~A) + +:::tip +For best results when asking for help: + +- Give details like what you did, what you expected to happen, and what actually happened +- Share relevant code and error messages +::: + +### Code checkers + +- [Text diff checker](https://www.diffchecker.com/) (for comparing different versions of text) +- [Markdown previewer](https://markdownlivepreview.com/) (does not work with variables) +- [YAML syntax validator](https://codebeautify.org/yaml-validator/) (ignore the "expected a single document in the stream, but found more" error) +- [Python syntax validator](https://extendsclass.com/python-tester.html) +- [Jinja syntax validator](https://www.dainiak.com/jinja2-playground/) (Only validates very, very simple Jinja. For example, syntax like `%p` (as in `{%p if True %}`) results in errors.) +- [Gherkin syntax validator](https://www.assertthat.com/online-gherkin-editor) (for ALKiln tests) + +We have not found a Mako validator (Markdown with variables and python). + +### Code documentation + +While building interviews you will most likely have one or more documentation websites ("docs") open at all times. And when you ask for help in one of the community resources, above, you will often receive a link to documentation as part of a response. This is generally meant to be helpful, not as a way to say "[RTFM](https://en.wikipedia.org/wiki/RTFM)." + +These are the essential documentation websites to have on hand: + +- [This website](/) +- [Docassemble docs](https://docassemble.org/docs.html) + +Docassemble interview files use several kinds of markup. Most of what you will need to know is included on the [Docassemble markup page](https://docassemble.org/docs/markup.html), but sometimes you may need to go to the source for more detailed documentation. + +- [YAML](https://yaml.org/spec/1.2/spec.html) (the base file format) +- [Markdown](https://daringfireball.net/projects/markdown/) (formatting text) +- [Mako](https://docs.makotemplates.org/en/latest/) (using variables and code within questions) +- [Python](https://docs.python.org/3/reference/index.html) (coding in Mako tags and [code blocks](https://docassemble.org/docs/code.html)) +- [Jinja](https://jinja.palletsprojects.com/en/3.0.x/) (used in [DOCX templates](../authoring/docx_templates.md)) + +You can also use [HTML](https://docassemble.org/docs/markup.html#markdownhtml), [CSS](https://docassemble.org/docs/ui.html#css), and [Javascript](https://docassemble.org/docs/initial.html#javascript) in Docassemble interviews. + +- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) (advanced formatting) +- [CSS](https://developer.mozilla.org/en/docs/Web/CSS/Reference) (customizing the UI) +- [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) and [jQuery](https://api.jquery.com/) (advanced customization) + +:::info JavaScript Workshop Resource +📺 **First Wednesday Workshop:** For practical guidance on integrating JavaScript into your Docassemble interviews, watch our workshop [Using JavaScript in Docassemble](https://suffolklitlab.org/using-javascript-in-docassemble/). This session covers common JavaScript patterns, jQuery integration, and best practices for enhancing interview functionality. +::: + +## Volunteer resources + +If you are a Document Assembly Line volunteer, these resources may be helpful. If you want to volunteer with the Document Assembly Line, sign up here: + + + +### People + +**Michelle B.** and **Sam Glover** are the lead volunteer coordinators. Michelle is a software engineer and the developer of [ALKiln](/docs/components/ALKiln/intro). She hosts coding help office hours twice a week and has been an active volunteer with the DAL since early days. Sam coordinates the Document Assembly Line in general. Both can be found in Teams. + +### Communication + +Teams—especially the [**Volunteers** channel](https://teams.microsoft.com/l/channel/19%3A51759e27ee9749c1956ad38f08560c1f%40thread.tacv2/Volunteers?groupId=eaa9bd9d-cf39-4686-8f30-e55aa9d98c75&tenantId=78733fa9-540e-4eb8-bf29-73c4eeb63412)—is our primary communication channel. We also prefer Teams chat over email. + +:::tip +If you can’t or don’t want to have Teams open all the time, turn on the **Missed activity emails** in the Teams settings under **Notifications and activity**. +::: + +### Common issues/FAQ + +
+ + **I can’t access the Document Assembly Line team in Teams** + + + Some workplaces block access to other Teams domains. You should be able to access the Document Assembly Line team in the web app, instead. It works exactly like the desktop app! + + You can also try using a different Microsoft account to log in. Let us know so we can send a Teams invite to your other email address. +
+ +
+ + **When committing to GitHub from the Playground, why aren’t I seeing the option to create a new branch?** + + + The short answer is that we forgot to add you to the [DAL volunteers team](https://github.com/orgs/SuffolkLITLab/teams/dal-volunteers) in GitHub. Please nudge us by posting a request in the [**Volunteers** channel](https://teams.microsoft.com/l/channel/19%3A51759e27ee9749c1956ad38f08560c1f%40thread.tacv2/Volunteers?groupId=eaa9bd9d-cf39-4686-8f30-e55aa9d98c75&tenantId=78733fa9-540e-4eb8-bf29-73c4eeb63412) in Teams. [Here is the longer answer.](https://teams.microsoft.com/l/message/19:51759e27ee9749c1956ad38f08560c1f@thread.tacv2/1758162954624?tenantId=78733fa9-540e-4eb8-bf29-73c4eeb63412&groupId=eaa9bd9d-cf39-4686-8f30-e55aa9d98c75&parentMessageId=1758146650660&teamName=Document%20Assembly%20Line&channelName=Volunteers&createdTime=1758162954624) +
\ No newline at end of file diff --git a/docs/react_components/VolunteerFormLink.jsx b/docs/react_components/VolunteerFormLink.jsx index 3fa678cc7..8fd581f76 100644 --- a/docs/react_components/VolunteerFormLink.jsx +++ b/docs/react_components/VolunteerFormLink.jsx @@ -16,21 +16,24 @@ export function VolunteerFormLink( props ) { sign_up_text = `Sign up to volunteer` } - return (
- { sign_up_text } - -
+ return ( +

+ + { sign_up_text } + +

) }; diff --git a/docs/volunteer/flows.mdx b/docs/volunteer/flows.mdx index 4d9d81bb8..a05f638b5 100644 --- a/docs/volunteer/flows.mdx +++ b/docs/volunteer/flows.mdx @@ -7,95 +7,68 @@ 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! - - - -
- -
- All - -## 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. +This page contains step-by-step workflows for volunteers. Not a volunteer? Join us: -
+ + +## Interview building and maintenance +
+ + **Register a developer account on the LIT Lab development server** + -
- Organizers + 1. [Register an account](https://apps-dev.suffolklitlab.org/user/register) on the development server. This will be a regular user account. + 2. You will need developer privileges, so [email us](mailto:litlab@suffolk.edu?subject=Request%20for%20a%20developer%privileges%20on%20the%20dev%20server) to request developer privileges. Include the email address you registered with and the reason you need developer privileges (i.e., "I'm a Document Assembly Line volunteer."). + 3. If your request is granted, you will need to log out and back in before you can access the Playground -## Organizers start +

+ Go to the Playground +

+
-Join the Microsoft Teams `#Volunteer Ops` channel. +
+ + **Set up and configure GitHub** + + 1. If you already have a GitHub account, [log in](https://github.com/login). If not, [create one](https://github.com/signup). + 2. If you want to keep your email address private, visit [your email settings](https://github.com/settings/emails) and turn on the **Keep my email addresses private** option + 3. Go to [your GitHub integration page](https://apps-dev.suffolklitlab.org/github_menu) and authorize your GitHub account + 4. After you complete the [interview builder training](../get_started/resources#training) and final project, ask an organizer to add you to the [DAL volunteers team](https://github.com/orgs/SuffolkLITLab/teams/dal-volunteers) on GitHub
+
+ + **Complete your first issue and pull request** + + + After you complete the [interview builder training](../get_started/resources#training) and final project, you are ready for your first issue! (An *issue* is an update, bug, enhancement, or other coding task.) + + When you are first starting to work on Docassemble interviews, it can be hard to judge the level of difficulty of an issue. We identify good issues for new builders with the **starter** label in GitHub. Sometimes we misjudge, so if you end up with an issue that seems above your skill level, [check in with us](../get_started/resources#communication). + + To get started on your first issue: + + 1. Pick a starter issue. You can visit the [**Interview updates** project board](https://github.com/orgs/SuffolkLITLab/projects/23/views/5) or [search starter issues in our GitHub repositories](https://github.com/search?q=org%3ASuffolkLITLab+is%3Aissue+label%3Astarter+is%3Aopen&type=issues) (the project board may be missing some starter issues). + 2. Is the issue a typo? + - If it is, continue + - If not, decide whether it is a good match for your level of experience. If you aren't sure, ask a more experienced member of the Builder crew. (Michelle is great resource for this!) + 3. Check to see if the issue is still up to date. Sometimes issues are fixed but not closed, or have become irrelevant for some other reason. If the issue should be closed, write a comment about why it can be closed and close it. Look for a different issue. + 4. Assign yourself to the issue and start working on it + 5. Follow the [GitHub workflow](../authoring/github#workflow) (also described in [training session 3](https://youtu.be/JpOaS8YeMvc?list=PLy6i9GFGw5Gy3oFiIhBpj5gn5PP_Vbd-5&t=2658)) + - When you commit your code, commit to a new branch + - Commit messages should be a reminder of what you did + - When creating a pull request, the comment should: + 1. Reference your issue(s) (e.g., `Closes #42`) so they will be closed when the pull request is merged + 2. Describe the changes you made in your code and why + - Request a review from `@SuffolkLITLab/dal-reviewers` for your pull request +
-
- Builders - -## 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` -
- - diff --git a/docs/volunteer/resources.mdx b/docs/volunteer/resources.mdx deleted file mode 100644 index 9c99c41b4..000000000 --- a/docs/volunteer/resources.mdx +++ /dev/null @@ -1,133 +0,0 @@ ---- -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! - - - -## General - -### Contacts - -Find us on Microsoft Teams! - -**Volunteer organizers:** Michelle, JJ, Chris
-**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) - - - -### Current projects {#projects_general} - -- [US states and territories Delegation of Parental Rights forms GitHub project](https://github.com/SuffolkLITLab/50StateDelegationOfParentalRights#readme) - - - -## 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. - - - - -### Current projects {#projects_ops} - -- [GitHub project **board** for US states and territories Delegation of Parental Rights](https://github.com/orgs/SuffolkLITLab/projects/95) - - - - - -## 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) - - - - - - - diff --git a/docusaurus.config.js b/docusaurus.config.js index 0e1be5bf1..5c44f6258 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -142,6 +142,10 @@ module.exports = { { from: '/docs/volunteer', to: '/docs/volunteer/sign_up' + }, + { + from: '/docs/volunteer/resources', + to: '/docs/get_started/resources' } ], diff --git a/sidebars.js b/sidebars.js index 8760fcfad..c22e52043 100644 --- a/sidebars.js +++ b/sidebars.js @@ -29,7 +29,6 @@ module.exports = { type: 'category', items: [ 'volunteer/sign_up', - 'volunteer/volunteer_resources', 'volunteer/volunteer_flows', ] },