Skip to content

Commit a0e7828

Browse files
author
Rafael Teodoro
committed
Update documentation for educational focus with simplified examples
- Changed all examples from corporate to educational scenarios - Updated OU paths: /Sales → /Students/Grade-10, /Marketing → /Faculty/Science - Updated email domains: company.com → school.edu - Simplified Attribute Injector format explanation - Added simple attribute values: student, teacher, staff, admin - Updated use cases for schools: * Class mailing lists * Faculty department groups * Student clubs and activities * Grade level access * SIS integration Applies to: English documentation (EN) Pending: Spanish (ES) and Portuguese (PT) translations
1 parent 066c471 commit a0e7828

File tree

6 files changed

+137
-116
lines changed

6 files changed

+137
-116
lines changed

docs/es/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# GWorkspace Toolbox
22

3-
Bienvenido a GWorkspace Toolbox - un potente conjunto de herramientas diseñado para administradores de Google Workspace para optimizar las operaciones diarias y tareas de gestión.
3+
Bienvenido a GWorkspace Toolbox - un potente conjunto de herramientas diseñado para administradores de Google Workspace en escuelas e instituciones educativas para optimizar las operaciones diarias y tareas de gestión.
44

55
## Resumen
66

7-
GWorkspace Toolbox proporciona una interfaz moderna y fácil de usar para gestionar operaciones de Google Workspace que de otra manera requerirían scripts complejos o procesos manuales. Construido con eficiencia y facilidad de uso en mente, ayuda a los administradores a ahorrar tiempo y reducir errores.
7+
GWorkspace Toolbox proporciona una interfaz moderna y fácil de usar para gestionar operaciones de Google Workspace que de otra manera requerirían scripts complejos o procesos manuales. Construido con eficiencia y facilidad de uso en mente, ayuda a las escuelas a ahorrar tiempo y reducir errores.
88

99
## Características Principales
1010

docs/features/alias-extractor.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,37 @@ The generated CSV file contains the following columns:
2121

2222
| Column | Description | Example |
2323
|--------|-------------|---------|
24-
| Primary Email | User's primary email address | john.doe@company.com |
25-
| Alias | The alias email address | j.doe@company.com |
24+
| Primary Email | User's primary email address | emily.johnson@school.edu |
25+
| Alias | The alias email address | e.johnson@school.edu |
2626

2727
### Sample CSV Output
2828
```csv
2929
Primary Email,Alias
30-
john.doe@company.com,j.doe@company.com
31-
john.doe@company.com,jdoe@company.com
32-
jane.smith@company.com,j.smith@company.com
30+
emily.johnson@school.edu,e.johnson@school.edu
31+
emily.johnson@school.edu,ejohnson@school.edu
32+
michael.chen@school.edu,m.chen@school.edu
33+
sarah.williams@school.edu,swilliams@school.edu
3334
```
3435

35-
## Use Cases
36+
## Use Cases for Schools
37+
38+
### Student Information System Integration
39+
Export aliases to match records between Google Workspace and your SIS (PowerSchool, Infinite Campus, etc.)
3640

3741
### Email Migration Planning
38-
Before migrating to a new email system, export all aliases to ensure they're preserved in the migration process.
42+
Before migrating to a new email system, export all aliases to ensure student and staff aliases are preserved.
3943

40-
### Compliance Auditing
41-
Generate regular reports of all email aliases for compliance and security audits.
44+
### Yearbook and Directory Publishing
45+
Generate accurate email listings for school directories and yearbooks.
4246

43-
### Documentation
44-
Maintain up-to-date documentation of email routing and alias configuration.
47+
### Alumni Records
48+
Document email aliases for graduating students before archiving their accounts.
4549

4650
### Cleanup Operations
47-
Identify unused or redundant aliases for cleanup and optimization.
51+
Identify unused or redundant aliases, especially after student transfers or staff changes.
4852

49-
### Cost Analysis
50-
Understand alias distribution across your organization for licensing and cost analysis.
53+
### Parent Communication Lists
54+
Identify all email addresses where parents can reach teachers and staff.
5155

5256
## Performance
5357

docs/features/attribute-injector.md

Lines changed: 43 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Google Workspace supports custom user attributes through custom schemas. The Att
1010

1111
## How It Works
1212

13-
1. **Select Target OU**: Enter the organizational unit path (e.g., `/Sales/Regional`)
13+
1. **Select Target OU**: Enter the organizational unit path (e.g., `/Students/Grade-12`)
1414
2. **Specify Attribute**: Enter the custom attribute name from your schema
15-
3. **Set Value**: Enter the value to assign to all users
15+
3. **Set Value**: Enter the value to assign to all users (e.g., "student", "staff", "teacher")
1616
4. **Inject**: Click "Inject Attributes" to apply changes
1717
5. **Review Results**: See how many users were updated successfully
1818

@@ -24,78 +24,79 @@ Before using the Attribute Injector, you must create a custom schema in Google W
2424
1. Go to [Google Admin Console](https://admin.google.com)
2525
2. Navigate to **Directory** > **Users** > **Manage custom attributes**
2626
3. Click **Add Custom Attribute**
27-
4. Create your schema (e.g., "EmployeeInfo")
28-
5. Add fields (e.g., "department", "costCenter", "employeeType")
27+
4. Create your schema (e.g., "SchoolInfo")
28+
5. Add fields (e.g., "role", "gradeLevel", "building", "studentID")
2929

3030
## Usage Example
3131

32-
### Scenario: Assign Department Code
32+
### Scenario: Assign Role to Students
3333

34-
You want to assign department code "SALES-NA" to all users in the North American Sales OU.
34+
You want to assign the role "student" to all users in the Grade 12 OU.
3535

3636
**Steps:**
37-
1. Organizational Unit: `/Sales/North America`
38-
2. Attribute Name: `EmployeeInfo.department`
39-
3. Attribute Value: `SALES-NA`
37+
1. Organizational Unit: `/Students/Grade-12`
38+
2. Attribute Name: `SchoolInfo.role`
39+
3. Attribute Value: `student`
4040
4. Click **Inject Attributes**
4141

42-
**Result:** All users in `/Sales/North America` now have `department = "SALES-NA"`
42+
**Result:** All users in `/Students/Grade-12` now have `role = "student"`
4343

4444
## Attribute Name Format
4545

46-
Attributes must be specified in the format: `SchemaName.FieldName`
46+
Attributes are specified in the format: `SchemaName.FieldName`
4747

48-
**Examples:**
49-
- `EmployeeInfo.department`
50-
- `EmployeeInfo.costCenter`
51-
- `EmployeeInfo.employeeType`
52-
- `CustomData.region`
48+
**Simple Examples:**
49+
- `SchoolInfo.role` with values like: `student`, `teacher`, `staff`, `admin`
50+
- `SchoolInfo.gradeLevel` with values like: `K`, `1`, `2`, `12`, `Graduate`
51+
- `SchoolInfo.building` with values like: `Main`, `North`, `South`
5352

54-
## Common Use Cases
53+
**Important:** You can use simple, plain text values like "student" or "teacher" - no complex codes needed!
5554

56-
### Department Assignment
57-
Assign department codes or names to all users in departmental OUs.
55+
## Common Use Cases for Schools
56+
57+
### Assign User Roles
58+
Identify users by their role in the school.
5859

5960
```
60-
OU: /Engineering
61-
Attribute: EmployeeInfo.department
62-
Value: ENG
61+
OU: /Faculty/Science
62+
Attribute: SchoolInfo.role
63+
Value: teacher
6364
```
6465

65-
### Cost Center Tracking
66-
Apply cost center codes for financial reporting.
66+
### Set Grade Levels
67+
Tag students by their current grade level.
6768

6869
```
69-
OU: /Finance/Accounts Payable
70-
Attribute: EmployeeInfo.costCenter
71-
Value: FIN-AP-001
70+
OU: /Students/Grade-9
71+
Attribute: SchoolInfo.gradeLevel
72+
Value: 9
7273
```
7374

74-
### Employee Classification
75-
Tag users by employee type for policy application.
75+
### Building Assignment
76+
Track which building or campus users belong to.
7677

7778
```
78-
OU: /Contractors
79-
Attribute: EmployeeInfo.employeeType
80-
Value: Contractor
79+
OU: /Students/Elementary
80+
Attribute: SchoolInfo.building
81+
Value: Elementary Campus
8182
```
8283

83-
### Regional Identification
84-
Mark users by geographic region for compliance or localization.
84+
### Department Classification
85+
Assign faculty to academic departments.
8586

8687
```
87-
OU: /Europe/Germany
88-
Attribute: EmployeeInfo.region
89-
Value: EU-DE
88+
OU: /Faculty/Mathematics
89+
Attribute: SchoolInfo.department
90+
Value: Math
9091
```
9192

92-
### Project Assignment
93-
Track project affiliations for cross-functional teams.
93+
### Student Type
94+
Differentiate between different student categories.
9495

9596
```
96-
OU: /Projects/Phoenix
97-
Attribute: ProjectInfo.assignment
98-
Value: PHX-2024
97+
OU: /Students/Special-Programs
98+
Attribute: SchoolInfo.studentType
99+
Value: Gifted and Talented
99100
```
100101

101102
## Permissions Required

docs/features/ou-group-sync.md

Lines changed: 55 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Keeping Google Groups synchronized with Organizational Units can be time-consumi
1010

1111
## How It Works
1212

13-
1. **Specify OU**: Enter the organizational unit path (e.g., `/Marketing`)
14-
2. **Select Target Group**: Enter the Google Group email (e.g., `marketing-team@company.com`)
13+
1. **Specify OU**: Enter the organizational unit path (e.g., `/Students/Grade-10`)
14+
2. **Select Target Group**: Enter the Google Group email (e.g., `grade10-students@school.edu`)
1515
3. **Choose Sync Mode**: Smart Sync or Full Sync
1616
4. **Optional Scheduling**: Enable daily automatic synchronization
1717
5. **Sync**: Click "Sync Now" or let the schedule handle it
@@ -33,9 +33,9 @@ Keeping Google Groups synchronized with Organizational Units can be time-consumi
3333

3434
**Example:**
3535
```
36-
OU Members: alice@, bob@, carol@
37-
Group Before: alice@, dave@ (manually added)
38-
Group After: alice@, bob@, carol@, dave@
36+
OU Members: student1@, student2@, student3@
37+
Group Before: student1@, teacher@ (manually added)
38+
Group After: student1@, student2@, student3@, teacher@
3939
```
4040

4141
### Full Sync
@@ -52,10 +52,10 @@ Group After: alice@, bob@, carol@, dave@
5252

5353
**Example:**
5454
```
55-
OU Members: alice@, bob@, carol@
56-
Group Before: alice@, dave@ (manually added)
57-
Group After: alice@, bob@, carol@
58-
Result: dave@ was removed
55+
OU Members: student1@, student2@, student3@
56+
Group Before: student1@, teacher@ (manually added)
57+
Group After: student1@, student2@, student3@
58+
Result: teacher@ was removed
5959
```
6060

6161
⚠️ **Warning**: Full Sync will remove manually added members. Only use when you want the group to exactly match the OU.
@@ -86,74 +86,90 @@ The interface shows:
8686
- **Remove**: Click the "Delete" button next to a scheduled job
8787
- **Modify**: Delete the existing schedule and create a new one
8888

89-
## Common Use Cases
89+
## Common Use Cases for Schools
9090

91-
### Department Access Groups
91+
### Class Mailing Lists
9292

93-
Automatically grant department access to resources:
93+
Automatically maintain class email groups:
9494

9595
```
96-
OU: /Sales
97-
Group: sales-department@company.com
98-
Mode: Smart Sync
96+
OU: /Students/Grade-10
97+
Group: grade10-students@school.edu
98+
Mode: Full Sync
9999
Schedule: Enabled
100100
101-
Result: All sales team members automatically get access to:
102-
- Shared drives
103-
- Internal sites
104-
- Department resources
101+
Result: All 10th grade students automatically in mailing list:
102+
- Teachers can email entire class
103+
- Updates when students transfer
104+
- Clean roster for school year
105105
```
106106

107-
### Team Mailing Lists
107+
### Faculty Department Groups
108108

109-
Maintain team mailing lists automatically:
109+
Keep faculty department groups current:
110110

111111
```
112-
OU: /Engineering/Backend
113-
Group: backend-team@company.com
112+
OU: /Faculty/Science
113+
Group: science-faculty@school.edu
114114
Mode: Full Sync
115115
Schedule: Enabled
116116
117-
Result: Group always reflects current backend team roster
117+
Result: Group always reflects current science department roster
118118
```
119119

120-
### Project Groups
120+
### Student Clubs and Activities
121121

122-
Keep project groups up-to-date:
122+
Manage extracurricular group memberships:
123123

124124
```
125-
OU: /Projects/Phoenix
126-
Group: project-phoenix@company.com
125+
OU: /Students/Clubs/Robotics
126+
Group: robotics-club@school.edu
127127
Mode: Smart Sync
128128
Schedule: Enabled
129129
130-
Result: All project members included, plus any external stakeholders
130+
Result: All robotics club members included, plus coaches and mentors
131+
```
132+
133+
### Grade Level Access
134+
135+
Grant grade-appropriate resource access:
136+
137+
```
138+
OU: /Students/Grade-12
139+
Group: seniors@school.edu
140+
Mode: Full Sync
141+
Schedule: Enabled
142+
143+
Result: Seniors get access to:
144+
- Senior-only Classroom courses
145+
- College prep resources
146+
- Graduation planning materials
131147
```
132148

133-
### Onboarding Automation
149+
### New Student Onboarding
134150

135-
Automatically add new hires to appropriate groups:
151+
Automatically add new students to orientation groups:
136152

137153
```
138-
OU: /New Hires/2024
139-
Group: orientation-2024@company.com
154+
OU: /Students/New-2024
155+
Group: new-students-2024@school.edu
140156
Mode: Smart Sync
141157
Schedule: Enabled
142158
143-
Result: New employees added to group as they're placed in OU
159+
Result: New students added to orientation group as they're enrolled
144160
```
145161

146-
### Regional Distribution
162+
### Campus Building Groups
147163

148-
Sync regional teams for location-specific communication:
164+
Sync users by physical campus or building:
149165

150166
```
151-
OU: /Europe/Germany
152-
Group: germany-team@company.com
167+
OU: /Students/Elementary
168+
Group: elementary-campus@school.edu
153169
Mode: Full Sync
154170
Schedule: Enabled
155171
156-
Result: Only German office members in group
172+
Result: Only elementary campus students and staff in group
157173
```
158174

159175
## Permissions Required

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# GWorkspace Toolbox
22

3-
Welcome to GWorkspace Toolbox - a powerful suite of tools designed for Google Workspace administrators to streamline daily operations and management tasks.
3+
Welcome to GWorkspace Toolbox - a powerful suite of tools designed for Google Workspace administrators in schools and educational institutions to streamline daily operations and management tasks.
44

55
## Overview
66

7-
GWorkspace Toolbox provides a modern, user-friendly interface for managing Google Workspace operations that would otherwise require complex scripts or manual processes. Built with efficiency and ease of use in mind, it helps administrators save time and reduce errors.
7+
GWorkspace Toolbox provides a modern, user-friendly interface for managing Google Workspace operations that would otherwise require complex scripts or manual processes. Built specifically for educational administrators, it helps schools save time and reduce errors when managing students, faculty, and staff accounts.
88

99
## Key Features
1010

0 commit comments

Comments
 (0)