Questions from Developers

[ExperimentsInHonesty]

Overview

We need to track the questions that developers ask in the beginning of their tenure, so that we can create a faq in the wiki

Action Items

• [ ] Add your questions to a comment below

Resources/Instructions

• https://github.com/hackforla/knowledgebase
• BOP: Overview of topic areas spreadsheet - tallies
• Project board for developers https://github.com/hackforla/knowledgebase/projects/1
• BOP Figma
• wiki: https://github.com/hackforla/knowledgebase/wiki
• https://github.com/hackforla/BOP/wiki
• BOP review document - This document is a work in progress, and has old versions of the charts per topic, but gives a good general idea on two of the topics what kind of narrative might be written.
• pnp spreadsheet
• Brigade Organizer’s Playbook Extension Project: Quantitative Analysis Report

[ExperimentsInHonesty]

My understanding related to BOP project specific details:

• Initially the assets will be fetched from the gSheet with all assets we have collected so far from different brigades. In future, there will be an Admin UI that will add this information with some approval workflow.
• Create a Django web app (not sure yet if we are going to reuse Knowledge base project)
• Instead of creating a DB, we could initially use Git to save these assets with metadata (like how Knowledge base project is collecting).
• This new Django web app will create APIs to perform CRUD operations for the assets from Git with their metadata & display them on the Web page.

My understanding related to knowledgebase project from technical perspective:

• Review the Wiki linked in https://github.com/hackforla/knowledgebase. -- This is an app built in Django to refer so we can analyze if we can use something similar for the BOP project. -- It takes Google Docs as input and transforms them in a markdown format, which is then rendered on the web. https://github.com/hackforla/knowledgebase/tree/main/utils/gdocs2md -- See https://github.com/hackforla/knowledgebase/wiki/Technical:-Design
• The difference between the above app & BOP is that for BOP we cannot control which documents other orgs use so we will need data storage.

[bonniewolfe]

We will need to add the following fields to gdocs

• asset type (google doc, google sheet, xls sheet, word doc, pdf, video etc.)
• organization that author belongs to
• asset group (its part of - fk)
• bop topic area (if applicable)

add asset group

this gets added equal to gdocs

Image from Knowledgebase

[Toe12]

28th Oct 23

In regards to Summary of Oct 27 Meeting on Knowledgebase and BoP

Since we will store metadata about content, could we use NoSQL for instance, MongoDB? We chose relational databases because the BOP will be synchronized with the Knowledge and PeopleDepot?

For the APIs, we just need to set up create and retrieve (to summarize the asset data) endpoints and do the deletions and updates from the Django admin portal tentatively speaking?

[ExperimentsInHonesty]

We will be using Postgres hosted on AWS.

[ExperimentsInHonesty]

@ethan asked

In regards to Summary of Oct 27 Meeting on Knowledgebase and BoP

Toe for Ethan: Since we will store metadata about content, could we use NoSQL for instance, MongoDB? We chose relational databases because the BOP will be synchronized with the Knowledge and PeopleDepot? Ethan: If attributes of metadata are known I read an article that convinced me relation is better. I will try to dig up the article. PostGres also lets you have JSON fields and you can refer to the JSON attributes.

Toe for Ethan: For the APIs, we just need to set up create and retrieve (to summarize the asset data) endpoints and do the deletions and updates from the Django admin portal tentatively speaking? Ethan: Creation, deletions and updates can be done from Django admin with no API. An API will be needed to retrieve all information about an asset so other applications can use it. Depending on the UI and functional requirements, Django admin may also be able to provide the screen for viewing the summary data - probably not long term, maybe for MVP.

[ejennywhiley123]

I have questions regarding the survey data and how it was collected. Who is the best person to connect with on this topic please?

My questions are related to understanding whether the survey data is representative of all US brigades, and also the base used for % calculations in cols K, M, Q, S:

1. What is the total number of brigades in the USA?
2. How does this number break down across large and small MSAs?
3. How are large and small MSAs defined?
4. In the GSheet "BOP: Overview of topic areas" on the "Tallies" tab, I see in cells A1:2 that there was an adjusted total # of brigades surved of 84 (28 large MSA + 56 small MSA) but then column B shows only 72 responses. What is the reason for this difference between 84 and 72?
5. What was the breakdown of the 72 responses across large and small MSAs?
6. If brigades surveyed were a sample of the total, how were survey participants selected?
7. Did some brigades contribute multiple responses or was only one response allowed per brigade?, i.e., are the 72 responses coming from 72 different brigades or from fewer than 72 brigades

[ExperimentsInHonesty]

Find the report by Jon K for quant

[ethanstrominger]

• [x] Reminder for Bonnie: find the report by Jon K for quant
• [ ] Incubator access
• [ ] Summary of response to ejennywhiley123 - has this been answered?
• [x] Can a script be created to populate assets and asset types from https://docs.google.com/spreadsheets/d/1YEWPIjfEPLd6FrjRKKHcmLt_9Ukk-vmSVPzVLCW63zc/edit?pli=1#gid=1734562905 or a subset?
• [x] Why do issue templates have ### as first level heading?
• [x] Organization / Brigade
  • [x] Should contributors to an asset be limited to users from that org?
• [x] Proposals:
  • [x] New screen to replace toolkit
    • [x] Add toggle to display a list of assets or a list of asset groups on new BOP query screen
    • [x] Add toggle to show plain list or to show in grid format
  • [x] remove description from Tool, Asset Type, Program Area, and Practice Area
  • [x] keep log of data changes
  • [x] org / contributors:
    • [x] add organization to People Depot users. - Ethan: look for issue
    • [x] include contributors who are not users in users table and have way to convert them to a user -
    • [x] allow. for multiple orgs
  • [x] Toolkit: Option for list? (Ethan's pet peeve, prefer list :-) )
• [x] Unable to access incubator, left Slack message https://hackforla.slack.com/archives/CV7QGL66B/p1701464313121039
• [ ] Best resource to review security for People Depot and Knowledgebase
• [x] model for storing sources will be called organization - ok?
• [x] See questions Query Data Criteria Wiki article

[ejennywhiley123]

@bonniewolfe @ag2463 shared the Jon K quant report with me. The link is here: (https://rpubs.com/jkropko/775977)

[ExperimentsInHonesty]

Descriptions for:

• Tool: If the guides are about a tool (e.g., How to Set Up New Project Vaults in 1Password, How to use ZeroHeight in Figma). Can be multiple.
• Asset Type: The format type of the asset (e.g., Google Doc, PDF, Powerpoint, Google Slides, etc.)
• ~Program Area~: - we have depreciated this
• Practice Area: if it is relevant to a specific Community of Practice (e.g., Research, Product/Project, Design, Engineering, Marketing, Admin, etc.). Can be multiple.
• Topic Area: also called Asset...(can't remember what the spreadsheet calls it) is the subject area the guide falls into. (We may need some new categories in the future, or we might change categories. e.g., Building a Core Team, Fundraising, etc.)

Additional meeting notes

Move up the development of the entity table people need to be able to have multiple entities if they are a member of another brigade, they will be prompted to add hack for la if they are also a member there.

[ExperimentsInHonesty]

These are the fields we anticipate for the kb Refined Requirements: Google ID - Internal Title - Display Description - Display Slug - Internal Active (T/F) - Internal Practice Area - Display Status - Display Published (T/F) - Internal Contributor(s) - Display Tool - Display Internal Source - Display if value provided External Source - Display if value provided Topic Area - Display Usability Rating - Display Review - Display

[ExperimentsInHonesty]

The following terms will be replaced with source-external and source-internal in the database, but will display as source on webpages. The source-internal will come from the orgs in People Depot.

• org
• entity
• brigade
• source

[ethanstrominger]

• [ ] Remove folder (issue2978)issue 2978
• [ ] How to access other experts, who are the experts? Specifically security, but others
• [ ] NO - Confirm get rid of program area from PD
• [ ] Specifics for usability rating
• [ ] Anything except user and user relationships require security?events, faq views, faqs, locations?,permission types?, practice areas, projects, skills, sponsor partners, stack element types, technologies
• [ ] Technology or Tool (Technology in People Depot, did we finalize on tool?)
• [ ] How are new tables added? https://github.com/hackforla/peopledepot/issues/56
• [ ] What tables need description? events, faq views, faqs, locations,permission types, practice areas, projects, skills, sponsor partners, stack element types, technologies
• [ ] Fields for organization

[ExperimentsInHonesty]

Usability rating

• 1 - Not at all documented
• 2 - Skeleton outline
• 3 - Could be used by another brigade with someone to walk them through the process
• 4 - Could be used by another brigade with a short summary of the process
• 5 - Could be used by another brigade without extra consultation or context

[ag2463]

I have questions regarding the survey data and how it was collected. Who is the best person to connect with on this topic please?

My questions are related to understanding whether the survey data is representative of all US brigades, and also the base used for % calculations in cols K, M, Q, S:

1. What is the total number of brigades in the USA?
2. How does this number break down across large and small MSAs?
3. How are large and small MSAs defined?
4. In the GSheet "BOP: Overview of topic areas" on the "Tallies" tab, I see in cells A1:2 that there was an adjusted total # of brigades surved of 84 (28 large MSA + 56 small MSA) but then column B shows only 72 responses. What is the reason for this difference between 84 and 72?
5. What was the breakdown of the 72 responses across large and small MSAs?
6. If brigades surveyed were a sample of the total, how were survey participants selected?
7. Did some brigades contribute multiple responses or was only one response allowed per brigade?, i.e., are the 72 responses coming from 72 different brigades or from fewer than 72 brigades

@ejennywhiley123 In the Quantitative report we did not collect information regarding Active members and that would have enabled us to see if a Brigade was really a Large or Small Brigade. Jon collected meetup numbers and used that to determine Small or Large, and we believe those numbers to be misleading, which he alludes to in his report. After this report was delivered it was determined that we would used Metropolitan Statistical Area (MSA) size as the metric to determine Large and Small Brigades.

[ethanstrominger]

• [x] Remove folder (issue2978)issue 2978
• [x] Meeting schedule
• [x] Status - in AssetGroup or Asset?

[ExperimentsInHonesty]

@ejennywhiley123 @kit-katrina20 Sorry for the delay, here are proper numbers. Sourced from the origin spreadsheet: BOP Interview Responses and Tracking

It looks like there is other relevant data in that spreadsheet, but it has some serious problems with it. We will contact the original developer of it, and get back to you, hopefully, with the actual number of large MSA and small MSA brigades surveyed and some other data about length of leadership and other numbers.

Brigades and Interview number	Number	Notes
Interviews Completed:	72	Some interviews, were conducted where two people from the same brigade has seperate interviews
People interviewed:	78	This is number of interviews completed (72) where in some interviews, multiple people from the same brigade attended
Participating Brigades:	65	This is number of interviews completed (78) with the only the first representative from that Brigades interview being counted

[ethanstrominger]

• [ ] File with no folder? I can only do suggestions, can't view file history https://docs.google.com/document/d/1Tx17ewpeI8r7u_-nSazJtUPjKsFeiSYWu-qmJAsbV3I/edit