Review and Update Onboarding Documentation

[kchotani]

Overview

This issue has been created to review onboarding documentation and to ensure that it is clear and provides all the relevant information for new members joining the Civic Tech Jobs project.

Action Items for MK Docs

• Review Mk Docs page for CTJ and propose updates
• Fix mkdocs deployment #456 is completed
• Implement proposed changes
• Update Onboarding Issue Template Accordingly

Action Items for Read Me

• Update the readme.md project board link to: https://github.com/orgs/hackforla/projects/37
• Update the readme.md google drive link to: https://drive.google.com/drive/u/2/folders/1hXxvpC8W5Uuzjqo4CxnjDpAMI7sbVnq8
• Update One Sheet

Before Closing Issue

• Review comments in this issue and create new issues as needed i.e. Add Requirements Doc

Resources

Access the Data Wiki page
Proposed MK docs updates
MK Doc folder

[kcoronel]

Need to add the Kanban Board Onboarding Section (from GitHub classics project) to the MK Docs: #537

[kcoronel]

Proposed MK docs updates

[LoTerence]

Sounds good to me. Let me know via slack whenever the mk docs copy is finalized.

I will get the #561 tasks done by tomorrow.

Update:
Just moved the tasks from 561 to here and closed it out ✅

[kcoronel]

Add requirements doc

[kcoronel]

Questions/Comments/Suggestions

• Update for Read Me: Project Context Section should have the One sheet above the paragraph describing the people working on the project. Preferably a line that says to review the one sheet for an outline on project details and then more about the people.

• NEED TO DO: The One sheet document itself lists what is live and what is pending and on the 6 month roadmap, however it doesn't give an overview of the features that are being built for MVP. I understand the one page is meant to be more concise, but this information could be captured as scope on one pager and in more detail on the mk docs wiki (perhaps?) so new members understand the functionality being built. (Adding a feature based Roadmap?)

• Question for clarification - which project is doing the matching of the volunteer to the open listing? CTJ or the CMS? My understanding is that this is part of CTJ project. It would be helpful to have a paragraph explaining the two teams, what their scope is and how they are working together for MVP. So new members are clear on the scope, and dependency on other teams? ( Combined Roadmap or Feature list?)

• Under Technology Used | Documentation Section - MKdocs and the doc site are listed together. To be consistent with how other technologies have been listed, perhaps only listing mkdocs navigating to the doc site.

[kcoronel]

Taken from #555
GitHub Readme
Intro Para 1

The website's main features include a linklist to public interest job boards and other resources relevent to their focused journey to work on projects and solve problems with a public benefit.

When I first read this, I wasn’t sure what "linklist" meant in this context. While I think I was able to infer its meaning from the surrounding text, I’m unsure if it’s a commonly used term in design or refers to a specific UI element.
Typo fix: "relevant"
Intro Para 2

The CivicTechJobs.org MVP site will be a platform to help prospective volunteers find inter disciplinary projects that will be useful for their career development while contributing to positive civic impact and a CMS for Hack for LA projects to be able to list their open roles.

Typo fix: "interdisciplinary"

Intro Para 3

Future iterations of the platform will focus helping volunteers find volunteer opportunities that match paid job postings, so that a volunteer can better prepare themselves for the marketplace.

Typo fix: "focus on helping"

Technology used section > Collaboration Technologies

Point 1 : GitHub project board link inactive(404 page):
https://github.com/hackforla/CivicTechJobs/projects/1

Mk Docs - Project Documentation
Home Page > Hasn't it been done already?

Read more about what lead up to us developing this project, at our History page.

Link inactive(404): https://hackforla.github.io/CivicTechJobs/History
(Though link to history page is active on Docs/Misc/History: https://hackforla.github.io/CivicTechJobs/misc/history/)

Project Board Link
Inactive links(404): https://github.com/hackforla/CivicTechJobs/projects/1
Page locations: Nav Menu>Joining the Team (Content Writer, Data Scientist, Project Manager, UI/UX Designer, Web Developer, Other Volunteer)

Nav Menu> Joining the Team > Project Manager

Point 1: Google doc link is inactive(File deleted). URL: https://docs.google.com/document/d/11Fe7mNdmPBP5bD_yLJ1C0_I1TmoK47AuHHrdhdDyWCs/edit?usp=sharing
Point 3: OKRS link is inactive(404 page). URL: https://hackforla.github.io/CivicTechJobs/joining-the-team/product-manager/INSERT-PROJECT-OKRS-SPREADSHEET-LINK
Point 5: Product Management link is inactive(404 page). URL: https://hackforla/[INSERT-REPO-NAME]/projects/1?card_filter_query=label%3A"role%3A+product%2Fproject+mgmt"
Nav Menu> Joining the Team > UI/UX Designer

Starting Checklist > Point 3: Figma link does not open anywhere(might be a permission issue on my end though). Link: https://www.figma.com/files/team/1040075117587297658/Civic-Tech-Jobs?fuid=775836858007206739
Nav Menu> Joining the Team > UX Researcher

The first 3 links are inactive(404).
Nav Menu> Joining the Team > Web Developer

Starting Checklist

Point 1: Inactive(not found) README link. URL: https://github.com/hackforla/[INSERT-REPO-NAME]/blob/main/README.md
Point 2 & 4: All links are inactive(404).
Other Questions
I was going through the one-sheet and had a couple of questions:

CTJ one sheet para 2

Second, it will help the organization's efforts of being an inclusive and self-sustaining organization for anyone who chooses to volunteer for one day to years.

I’m curious about what "inclusion" refers to in this context. I did come across the web accessibility standards while going through the docs, but was wondering if this also includes any accessibility and DEI goals?

Would love to know more if it does

CTJ one sheet para 2

Future iterations of the platform will focus on helping volunteers find volunteer opportunities that match paid job postings, so that a volunteer can better prepare themselves for the marketplace.

I’m not sure I fully understand what "matching to paid job postings" means. Could you share more about what this looks like, how it works, and how it differs from our regular project postings on the CTJ website?

[LoTerence]

I just tested the mkdocs deployment and it works. We can deploy new changes to the docs. Let me know if you have any content ready to publish.