hackforla
Review and Update Onboarding Documentation
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
- [x] Review Mk Docs page for CTJ and propose updates
- [x] #456 is completed
- [ ] Implement proposed changes
- [ ] Update Onboarding Issue Template Accordingly
Action Items for Read Me
- [x] 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
@kchotani here is an issue I created for the new Dev lead - if it works out well, we can have this be a template and as soon as new project members are added to the repo this issue is created for them. https://github.com/hackforla/CivicTechJobs/issues/491
Also added Access the Data Wiki page as an example of another Hack for LA's project under resources above
Added a link to this document in our onboarding issue #375
@kchotani saw this document in the CTJ drive - super helpful doc for incoming PMs - https://docs.google.com/document/d/18bx-7Fl2advVLTrBEX4F2CEmS6cfz_Fv5VaT1HTAENE/edit we should see where we can add it in our onboarding documentation
Need to add the Kanban Board Onboarding Section (from GitHub classics project) to the MK Docs: https://github.com/hackforla/CivicTechJobs/issues/537
Comment below is from @nooriaali9 for us to consider while we update MK Docs
@kcoronel I meant the outdated links in the MKDocs - https://hackforla.github.io/CivicTechJobs/
The above image has all outdated links ^^
- In Content Writer ->
- Review the Project Board and identify an actionable backlog item.
- In Data Scientist ->
- Review the Project Board and identify an actionable backlog item. We are working to resolve some database architecture issues and are not onboarding new data scientist at this time.
- In Product Manager and Owner ->
- Learn how we setup our GitHub Kanban boards and please comment if there is anything in the document that is unclear.
- Review our OKRS.
- Review the Project Board and the Product Management issues available on that board to identify an actionable backlog item.
- Review Hack for LA Product Management Templates.
- In UI/UX Designer ->
- Review the UI/UX issues on the Project Management Board and identify an actionable backlog item.
- In UI/UX Researcher ->
-
In Web Developer -> Read the development Readme Review the project board by the type of issue you are looking for. The Frontend Coding Project Board or the Backend Coding Project Board. Or you can check out the entire project board here. Your first commit will likely be an issue labeled good first issue. Check the board for those issues. Don't worry if you don't see anything now, we are working on it.
-
In Other Volunteer -> Review the Project Board.
-
This will be updated I assume - https://hackforla.github.io/CivicTechJobs/misc/the-team/
Sorry for the chunky comment - This is so we have sort of a to - do list and a quick glance at the doc & are able to fix all the broken links in the https://hackforla.github.io/CivicTechJobs/
@kcoronel update google doc with Nooria's comments above
@nooriaali9 will take a look at the resources section of this issue, will report back next week timeline for updates
Suggestion from Peter: During my onboarding, I found myself clicking through multiple links to access the necessary documents and information. It felt a bit scattered, and I think it would be much easier if everything was available in one place, so people don’t have to jump around. Also, I noticed that the final link didn’t work, which added some frustration. Making these changes could really smooth out the onboarding experience.
Adding @LoTerence issue regarding MK Docs: https://github.com/hackforla/CivicTechJobs/issues/561
@LoTerence can you update issue this issue with the tasks from 561 and then close out 561 with a comment that we decided to capture everything in here. Thank you!
@LoTerence Nooria and I will follow-up later this week when we have all of our copy edits for MK Docs finalized and will ask you to then update them, does this work for you?
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 ✅
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.
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?
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.
@LoTerence I'm ready to get a meeting with you to get this first iteration of MK Docs updated (Yay!) Because this will be an iterative process, I would like to learn how to make the updates and document it for PM's. I can meet next week Wednesday 3/5 at 4pm.
Here's the copy edits doc: https://docs.google.com/document/d/1gm_cJJ-tdP8gZu6ZNet-4jzBrvkQbmPbwFOLxdAPdu8/edit?tab=t.0
And would like to update this with you as well :)
- [ ] Update the readme.md google drive link to: https://drive.google.com/drive/u/2/folders/1hXxvpC8W5Uuzjqo4CxnjDpAMI7sbVnq8
- [ ] Update One Sheet link to: https://docs.google.com/document/d/1gm_cJJ-tdP8gZu6ZNet-4jzBrvkQbmPbwFOLxdAPdu8/edit?tab=t.0
I'm free Wednesday 3/5 at 4pm PT. Please send me a calendar invite 😄
I'll be happy to show how to make updates to the docs.
Would you like me to make the above updates before our meeting or during?
Availability for this week: Limited My estimated ETA for completing this issue: Going to say that Part 1 of the updates should be completed by 3/9, Part 2 includes new documentation
Provide Update
Progress: Copy updates for Part 1 of the MK Docs updates completed, going to meet with Tech Lead (Terence) to document the process for updating the documentation and posterizing this for future use/future updates. Blockers: None Availability: 1hr for meeting and 30min to complete copy updates ETA: 3/9 Pictures: N/A