Skip to content

Commit c2fce48

Browse files
Add ALDashboard to documentation generation and navigation
Co-authored-by: nonprofittechy <7645641+nonprofittechy@users.noreply.github.com>
1 parent bb044cc commit c2fce48

File tree

5 files changed

+78
-0
lines changed

5 files changed

+78
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ jobs:
3838
with:
3939
repository: SuffolkLITLab/docassemble-EFSPIntegration
4040
path: docassemble-EFSPIntegration
41+
- uses: actions/checkout@v3
42+
with:
43+
repository: SuffolkLITLab/docassemble-ALDashboard
44+
path: docassemble-ALDashboard
4145
- name: Go to Docs directory
4246
run: |
4347
cd docs

.github/workflows/test-deploy.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ jobs:
3838
with:
3939
repository: SuffolkLITLab/docassemble-EFSPIntegration
4040
path: docassemble-EFSPIntegration
41+
- uses: actions/checkout@v3
42+
with:
43+
repository: SuffolkLITLab/docassemble-ALDashboard
44+
path: docassemble-ALDashboard
4145
- name: Go to Docs directory
4246
run: |
4347
cd docs
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
id: aldashboard_overview
3+
title: ALDashboard overview
4+
sidebar_label: Overview
5+
slug: /components/ALDashboard/overview
6+
---
7+
8+
ALDashboard is a collection of tools to help administer a Docassemble server and debug interviews. It provides utilities for package management, server maintenance, translation workflows, and debugging tools specifically designed for the Document Assembly Line ecosystem.
9+
10+
## Key Features
11+
12+
ALDashboard provides several categories of functionality:
13+
14+
### Package Management
15+
- Create and manage Docassemble packages
16+
- Scan and analyze package contents
17+
- Automated package building and deployment tools
18+
19+
### Translation and Internationalization
20+
- Translation workflow management
21+
- Multi-language support for interviews
22+
- Translation validation and quality assurance
23+
24+
### Server Administration
25+
- Server maintenance utilities
26+
- Package installation and updates
27+
- System diagnostics and monitoring
28+
29+
### Document Processing
30+
- DOCX file validation and processing
31+
- Attachment validation tools
32+
- Document template analysis
33+
34+
## Main Modules
35+
36+
ALDashboard consists of several Python modules, each providing specific functionality:
37+
38+
- **aldashboard.py** - Core dashboard functionality and server management
39+
- **create_package.py** - Package creation and management utilities
40+
- **translation.py** - Translation workflow and management tools
41+
- **project_maintenance.py** - Project maintenance and update utilities
42+
- **docx_wrangling.py** - DOCX document processing and validation
43+
- **package_scanner.py** - Package analysis and scanning tools
44+
- **validate_docx.py** - DOCX validation utilities
45+
- **validate_attachment.py** - Attachment validation tools
46+
47+
## Installation
48+
49+
ALDashboard is typically installed as part of the Document Assembly Line setup:
50+
51+
```bash
52+
pip install docassemble-ALDashboard
53+
```
54+
55+
Or install from the Docassemble package management interface by searching for "ALDashboard".
56+
57+
## Usage
58+
59+
ALDashboard provides both programmatic APIs and interview-based interfaces for server administration. Most functionality is accessed through the Docassemble web interface after installation.
60+
61+
## Related Documentation
62+
63+
- [Assembly Line Project Architecture](/docs/get_started/al_project_architecture)
64+
- [Installation Guide](/docs/get_started/installation)
65+
66+
## Repository
67+
68+
The ALDashboard source code is available at: https://github.com/SuffolkLITLab/docassemble-ALDashboard

pydoc-markdown.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ loaders:
55
- "../FormFyxer"
66
- "../docassemble-ALToolbox/docassemble/"
77
- "../docassemble-EFSPIntegration/docassemble"
8+
- "../docassemble-ALDashboard/docassemble/"
89
processors:
910
- type: filter
1011
skip_empty_modules: true

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ module.exports = {
164164
'components/RateMyPDF/ratemypdf_overview',
165165
'components/GithubFeedbackForm/githubfeedbackform_overview',
166166
'components/InterviewStats/interviewstats_overview',
167+
'components/ALDashboard/aldashboard_overview',
167168
{
168169
"label": "FormFyxer",
169170
"type": "category",

0 commit comments

Comments
 (0)