diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 2b8f1cbd..ab361b08 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,4 +1,5 @@ name: Deploy Documentation + on: push: branches: @@ -25,48 +26,19 @@ jobs: python-version: "3.11" cache: pip - # Step 3: Install required Python dependencies from requirements.txt + # Step 3: Install dependencies - name: Install dependencies run: | python -m pip install --upgrade pip - pip install --cache-dir ~/pip_cache -r requirements.txt - - # Step 4: Debug logging to ensure pip cache is created - - name: Check if pip cache exists - run: | - echo "Checking if pip cache directory exists..." - ls -l ~/pip_cache + pip install -r requirements.txt - # Step 5: Cache pip dependencies - - name: Cache pip dependencies - uses: actions/cache@v3 - with: - path: ~/pip_cache - key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }} - restore-keys: | - ${{ runner.os }}-pip- + # Step 4: Build MkDocs site + - name: Build MkDocs site + run: mkdocs build --strict - # Step 6: Cache MkDocs dependencies after pip cache - - name: Cache MkDocs dependencies - uses: actions/cache@v3 + # Step 5: Deploy MkDocs site to GitHub Pages + - name: Deploy MkDocs site to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 with: - path: ~/.cache - key: ${{ runner.os }}-mkdocs-v1-${{ hashFiles('mkdocs.yml') }} - restore-keys: | - ${{ runner.os }}-mkdocs-v1- - - # Step 7: Validate MkDocs configuration - - name: Validate MkDocs configuration - run: mkdocs build --config-file mkdocs.yml --strict - - # Step 8: Build and deploy documentation - - name: Build and deploy documentation - run: mkdocs gh-deploy --force - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - # Post-job cleanup (optional step to remove any temporary files if needed) - - name: Cleanup - run: | - echo "Post-job cleanup" - rm -rf ~/pip_cache # Optional: You can remove this if caching is working fine \ No newline at end of file + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./site \ No newline at end of file diff --git a/.gitignore b/.gitignore index cafb0259..0c27de65 100644 --- a/.gitignore +++ b/.gitignore @@ -65,3 +65,4 @@ static/ # Miscellaneous *.locksite/ +site/ \ No newline at end of file diff --git a/archive/Civic tech community organizer toolkit.docx b/archive/Civic tech community organizer toolkit.docx deleted file mode 100644 index 7c6ebe6d..00000000 Binary files a/archive/Civic tech community organizer toolkit.docx and /dev/null differ diff --git a/archive/civic-tech-community-organizer-toolkit.md b/archive/civic-tech-community-organizer-toolkit.md new file mode 100644 index 00000000..58d5312c --- /dev/null +++ b/archive/civic-tech-community-organizer-toolkit.md @@ -0,0 +1,128 @@ +# Civic Tech Community Organizer Toolkit + +**Version:** 1.0 +**Date:** August 30, 2017 +**Updated by:** Isha Nepal and Emily Kuzan + +--- + +## About This Toolkit + +Civic tech communities are being established in cities around the world. These volunteer-run hubs foster innovation and networking between public servants, technology professionals, designers, and civic activists. At the heart of these communities is the weekly “hacknight.” + +This toolkit provides key tips to help you establish and run successful hacknights. It is a collaborative, living document created by Isha Nepal and Emily Kuzan on behalf of Code for Canada, with contributions from organizers in the global civic tech community. + +--- + +## Table of Contents + +1. [About Civic Tech Community Groups](#about-civic-tech-community-groups) +2. [How to Start a Civic Tech Community Group](#how-to-start-a-civic-tech-community-group) +3. [How to Organize a Civic Tech Hacknight](#how-to-organize-a-civic-tech-hacknight) +4. [How to Keep Your Hacknights Running Smoothly](#how-to-keep-your-hacknights-running-smoothly) +5. [Templates You Can Adapt](#templates-you-can-adapt) +6. [Further Reading](#further-reading) +7. [Frequently Asked Questions (FAQs)](#frequently-asked-questions-faqs) +8. [Toolkit Requests and Roadmap](#toolkit-requests-and-roadmap) + +--- + +## About Civic Tech Community Groups + +The main goal of civic tech groups is to bring together individuals from diverse backgrounds to solve civic challenges using technology and design, typically through weekly “hacknights.” + +### Common Characteristics of Civic Tech Hacknights + +- **Regular Meetings:** Weekly, biweekly, or monthly gatherings lasting 2.5-3 hours. +- **Structured Agenda:** Introductions, optional presentations, and project hacking. +- **Inclusivity:** Civic Tech 101 sessions to onboard new members. + +### Key Ingredients for a Successful Hacknight + +1. **Environment:** Create a collaborative and welcoming space. +2. **Attendance:** Encourage diverse participation for cross-sector collaboration. +3. **Projects:** Provide at least two project options to engage participants. +4. **Adaptability:** Tailor hacknights to your community's specific needs. + +--- + +## How to Start a Civic Tech Community Group + +### 1. Find Co-Founders + +- Identify passionate individuals to share responsibilities. +- Reach out to colleagues or your network to build a founding team. + +### 2. Organize a Trial Hacknight + +- Test the concept with a small, prototype event. +- Promote through social media or platforms like Meetup.com. +- Seed the event with at least one project idea. + +--- + +## How to Organize a Civic Tech Hacknight + +### 1. Find a Venue + +- Look for accessible locations like tech firms, shared workspaces, libraries, or community centers. +- Ensure basic amenities like Wi-Fi, projectors, and workspaces. + +### 2. Find Speakers (Optional) + +- Speakers can provide insights and attract attendees. +- Rotate speakers monthly or invite individuals with relevant expertise. + +### 3. Send Invitations + +- Invite technologists, designers, civil servants, and community activists. +- Use email templates or social media to publicize the event. + +--- + +## How to Keep Your Hacknights Running Smoothly + +- Use tools like Meetup.com, Slack, and GitHub to stay organized. +- Rotate organizers to prevent burnout. +- Maintain clear roles with templates for agendas, speaker scheduling, and more. + +--- + +## Templates You Can Adapt + +These templates can be customized for your community: + +- Agenda and MC Talking Points +- Civic Tech 101 Slides +- Code of Conduct +- Hacknight Roles +- Speaker Scheduling + +--- + +## Further Reading + +- [Civic Tech Communities in Canada](http://codefor.ca/community-network/) +- [Code for America Brigades](http://brigade.codeforamerica.org/brigade/) + +--- + +## Frequently Asked Questions (FAQs) + +### How do civic tech hacknights differ from other hacknights? + +Civic tech hacknights include a civic-focused element, solving public interest issues in addition to technical challenges. + +### How can I connect local governments and activists? + +Collaboration starts with outreach and communication. Use platforms like Slack and Meetup to engage both groups. + +--- + +## Toolkit Requests and Roadmap + +We welcome feedback and suggestions to improve this toolkit. Share your ideas or request new content by commenting directly or reaching out to the authors. + +--- + +*This document is a living resource and will evolve with contributions from the global civic tech community.* diff --git a/docs/ctwr-templates/Event_Planning_Template.md b/docs/ctwr-templates/Event_Planning_Template.md index 6e761d00..bd81019e 100644 --- a/docs/ctwr-templates/Event_Planning_Template.md +++ b/docs/ctwr-templates/Event_Planning_Template.md @@ -3,24 +3,30 @@ ## Event Name ## Date and Time + Date and time of the event. ## Location + Event location details. ## Agenda + 1. Introduction 2. Speaker Session 3. Q&A 4. Networking ## Resources Needed + List of resources needed for the event. ## Promotion + - Social Media - Email - Flyers ## Follow-up -Steps for follow-up after the event. \ No newline at end of file + +Steps for follow-up after the event. diff --git a/docs/ctwr-templates/Meeting_Minutes_Template.md b/docs/ctwr-templates/Meeting_Minutes_Template.md index 61108ad7..24f8d768 100644 --- a/docs/ctwr-templates/Meeting_Minutes_Template.md +++ b/docs/ctwr-templates/Meeting_Minutes_Template.md @@ -1,6 +1,7 @@ # Meeting Minutes Template ## Date + [YYYY-MM-DD] ## Attendees (# of attendees) @@ -9,4 +10,4 @@ ## Notes -## Action Items \ No newline at end of file +## Action Items diff --git a/docs/faq/index.md b/docs/faq/index.md index 2ec889ba..480082ab 100644 --- a/docs/faq/index.md +++ b/docs/faq/index.md @@ -1,3 +1,41 @@ -# faq +# Frequently Asked Questions (FAQ) -Welcome to the faq section. +## What is CivicTechWR? + +CivicTechWR is a community group focused on solving local issues through design and technology. + +## How can I get involved? + +You can get involved by attending our meetups, joining our Slack, and contributing to our projects on GitHub. Check the [Get Involved](../index.md#get-involved) section for more details. + +## When and where are the meetups? + +Our meetups are usually scheduled regularly. You can find the latest schedule and venue details on our [Meetup page](https://www.meetup.com/civictechwr/). + +## How can I join the Slack community? + +Join our Slack community by following this [invite link](https://join.slack.com/t/civictechwr/shared_invite/zt-2ldijjy0i-gaGvPkuafPt9Zpn7jml70w). + +## What kind of projects does CivicTechWR work on? + +We work on a variety of projects that aim to address local community issues using technology and design. Check our [GitHub repository](https://github.com/CivicTechWR) to see our current and past projects. + +## How can I contribute to a project? + +You can contribute by checking out our projects on [GitHub](https://github.com/CivicTechWR) and following the contribution guidelines provided in each project repository. + +## Who can join CivicTechWR? + +Anyone with an interest in using technology and design to solve community issues is welcome to join. + +## Do I need any specific skills to join? + +No specific skills are required. We welcome people with diverse backgrounds and skill sets. + +## How can I stay updated on CivicTechWR activities? + +You can stay updated by joining our [Meetup group](https://www.meetup.com/civictechwr/), our [Slack community](https://join.slack.com/t/civictechwr/shared_invite/zt-2ldijjy0i-gaGvPkuafPt9Zpn7jml70w), and following our [GitHub repository](https://github.com/CivicTechWR). + +## Where can I find more information? + +For more detailed information, visit our [website](https://civictechwr.org). diff --git a/docs/guidelines/Communication_Guidelines.md b/docs/guidelines/Communication_Guidelines.md index 83722b14..830aaa8f 100644 --- a/docs/guidelines/Communication_Guidelines.md +++ b/docs/guidelines/Communication_Guidelines.md @@ -1,20 +1,24 @@ # Communication Guidelines ## Purpose + To ensure clear, respectful, and effective communication within the CivicTechWR community. ## General Principles + - Be respectful and considerate. - Listen actively and respond thoughtfully. - Use clear and concise language. ## Communication Channels + - **Slack:** For real-time communication and collaboration. - **Email:** For formal and detailed communication. - **GitHub:** For project-related discussions and issues. - **Meetup.com:** For event announcements, RSVPs, and community updates. ## Conflict Resolution + - Address conflicts promptly and respectfully. - Seek to understand different perspectives. -- Escalate to organizers if necessary. \ No newline at end of file +- Escalate to organizers if necessary. diff --git a/docs/guidelines/Contribution_Guidelines.md b/docs/guidelines/Contribution_Guidelines.md index b7fa71c6..7913c4ab 100644 --- a/docs/guidelines/Contribution_Guidelines.md +++ b/docs/guidelines/Contribution_Guidelines.md @@ -1,15 +1,18 @@ # Contribution Guidelines ## How to Contribute + - Fork the repository. - Create a new branch for your work. - Make your changes. - Submit a pull request for review. ## Best Practices + - Write clear and concise commit messages. - Follow the coding standards and style guide. - Test your changes thoroughly before submitting. ## Code of Conduct -Ensure your contributions align with our Code of Conduct. \ No newline at end of file + +Ensure your contributions align with our Code of Conduct. diff --git a/docs/guidelines/Event_Planning_Guide.md b/docs/guidelines/Event_Planning_Guide.md index 7aa51db8..279e00c0 100644 --- a/docs/guidelines/Event_Planning_Guide.md +++ b/docs/guidelines/Event_Planning_Guide.md @@ -5,26 +5,31 @@ This guide provides a structured approach to planning events within the CivicTec ## Steps for Planning an Event ### 1. Define the Event + - Purpose - Audience - Goals ### 2. Logistics + - Date and Time - Venue - Equipment ### 3. Promotion + - Marketing Materials - Channels (social media, emails, posters) - Timeline ### 4. Execution + - Team Roles and Responsibilities - On-the-Day Checklist - Contingency Plans ### 5. Post-Event + - Follow-Up with Participants - Feedback Collection - Reporting and Reflection diff --git a/docs/guidelines/SocialMedia_Guidelines.md b/docs/guidelines/SocialMedia_Guidelines.md index 95673964..5967d067 100644 --- a/docs/guidelines/SocialMedia_Guidelines.md +++ b/docs/guidelines/SocialMedia_Guidelines.md @@ -1,14 +1,17 @@ # Social Media Guidelines ## Purpose + To guide the appropriate and effective use of social media for CivicTechWR. ## Best Practices + - Be respectful and positive. - Use official hashtags and handles. - Share relevant content and updates. ## Platforms + - **Twitter:** For quick updates and engagement. - **Facebook:** For community interaction and event promotion. - **LinkedIn:** For professional networking and announcements. @@ -16,6 +19,7 @@ To guide the appropriate and effective use of social media for CivicTechWR. - **Meetup.com:** For event announcements and RSVPs. ## Content Guidelines + - Ensure accuracy and relevance. - Avoid controversial topics. -- Engage with followers respectfully. \ No newline at end of file +- Engage with followers respectfully. diff --git a/docs/index.md b/docs/index.md index 41eb0de6..4884cead 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,35 +5,54 @@ CivicTechWR is a community group dedicated to solving local issues through desig ## Sections ### Policies -- [Code of Conduct](policies/Code_of_Conduct.md) -- [Diversity and Inclusion Policy](policies/Diversity_and_Inclusion_Policy.md) + +Explore the principles and rules guiding our community: + +- [Code of Conduct](policies/Code_of_Conduct.md): Our standards for respectful and inclusive behavior. +- [Diversity and Inclusion Policy](policies/Diversity_and_Inclusion_Policy.md): Promoting diversity and equity. ### Guidelines -- [Communication Guidelines](guidelines/Communication_Guidelines.md) -- [Contribution Guidelines](guidelines/Contribution_Guidelines.md) -- [Event Planning Guide](guidelines/Event_Planning_Guide.md) -- [Social Media Guidelines](guidelines/SocialMedia_Guidelines.md) + +Learn how to communicate, contribute, and plan effectively: + +- [Communication Guidelines](guidelines/Communication_Guidelines.md): Best practices for communication. +- [Contribution Guidelines](guidelines/Contribution_Guidelines.md): Steps for getting involved and contributing. +- [Event Planning Guide](guidelines/Event_Planning_Guide.md): Organizing events and meetups. +- [Social Media Guidelines](guidelines/SocialMedia_Guidelines.md): Managing our social media presence. ### Meeting Minutes + +Keep track of past discussions and decisions: + - [2024-06-19 Meeting Minutes](meeting-minutes/2024-06-19_Meeting_Minutes.md) ### Templates + +Useful templates for effective collaboration: + - [Event Planning Template](ctwr-templates/Event_Planning_Template.md) - [Meeting Minutes Template](ctwr-templates/Meeting_Minutes_Template.md) ### FAQ + +Find answers to common questions: + - [Frequently Asked Questions](faq/index.md) ## Get Involved + Explore the documentation to find out how you can contribute to our projects, attend events, and collaborate with others in the CivicTechWR community. ### Attend Our Meetups + Join our community on [Meetup](https://www.meetup.com/civictechwr/) to stay updated on upcoming events and gatherings. ### Join Our Slack + Connect with us on [Slack](https://join.slack.com/t/civictechwr/shared_invite/zt-2ldijjy0i-gaGvPkuafPt9Zpn7jml70w) to participate in discussions, collaborate on projects, and stay in the loop with our latest activities. ### Contribute on GitHub + Check out our projects and contribute on [GitHub](https://github.com/CivicTechWR). -For more information, visit our [website](https://civictechwr.org). \ No newline at end of file +For more information, visit our [website](https://civictechwr.org). diff --git a/docs/meeting-minutes/2024-06-19_Meeting_Minutes.md b/docs/meeting-minutes/2024-06-19_Meeting_Minutes.md index 5033b4df..d02a8095 100644 --- a/docs/meeting-minutes/2024-06-19_Meeting_Minutes.md +++ b/docs/meeting-minutes/2024-06-19_Meeting_Minutes.md @@ -16,7 +16,9 @@ - 7:40 - 8:00 PM: Progress report and cleanup ## Notes + ### Sponsors + - Venue: Den 1880 - Food & Refreshments: Dreamside Digital - Software Tools: Foxxwood.com @@ -26,7 +28,7 @@ - Headshots by Terry postponed to July 3rd. If interested, reach out to Terry on Slack - Unfortunately we were not selected for the Upstream Fund - We are adopting the Seasons model! This is week 1 of season 1, which puts our cutoff for new projects at July 24, and our Demo Day at Sept 4. -- +- - If you want to become a CivicTechWR organizer, join the #organizers channel on Slack and check out the project board on Github. There’s lots to do! @@ -37,9 +39,9 @@ There’s lots to do! Outcome so far is to keep exploring and experimenting. #### Radical Transparency + - David proposed developing a platform that leverages AI to review and summarize city council meetings. - This platform can help people understand what took place in these meetings. - It can also be a valuable resource during election time, allowing voters to learn where candidates stand on the issues they care about most. - The ability to search within the platform would greatly help people stay informed. - This idea can also be adapted to other formats, such as school board meetings. -