Modify markdown, clean up print

Author: ethanstrominger

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Starting People Depot 
+## Stopping processes running on needed ported
+Follow these instructions if 5432, 5433, 8000, or 8001 are used by other applications.
+
+1. If Postgresql is running for another app other than People Depot, kill Postgresql
+
+For Mac
+-  Stop Postgresql: `brew services stop postgresql`
+- If it indicates a specific version was stopped (`Stopping ```postgresql@16```...`), 
+then stop that version: `brew services stop postgresql@16`
+
+For PC:
+- ???
+
+2. Repeat for 5433
+3. Kill process running on 8000: `kill -9 (lsof -ti:8000)`
+4. Repeat for 8001
+5. If you think databases on port 5432 or 5433 were used for a different application, then reinitialize or change where ports are started
+
+## Configure
+- From terminal:
+```
+cd django_root
+cp .env.local-example .env.local
+```
+- If you are using People Depot then check PEOPLE_DEPOT_URL is defined.  If not, check that it is commented out.
+- If you are using Cognito for login, get values for Cognito variables from a development admin or 1password.com (if 
+a HackForLA account has been setup).  You can also create your own Cognito domain if you want.  See ???
+
+## Start People Depot
+If you are not using People Depot APIs and don't want to set up replication from People Depot, then skip this section.
+
+See https://hackforla.github.io/peopledepot/contributing/dev_environment/ for instructions on how to start People Depot.  For the first time, this will create a container with a Postgresql database on port 5432 and a Django web server on port 8000.  Subsequent starts will use the docker container, database, and web server and perform any necessary migrations to the database.
+
+## Start Doc Conversion
+
+## Start Knowledgebase
+From terminal: `cd django_root`, then `source start-local.sh` or `source start-docker.sh`
+

NOTES.md

@@ -48,7 +48,6 @@ The API user must pick a version status - draft, in review, or approved - for an
 
 # Features
 ## Google Document Features
-# Technical Documentation
 
 # Technical Implementation
 ## Maintenance with Django

django_root/.env.local-example

@@ -1,25 +1,21 @@
 DJANGO_SETTINGS_MODULE=core.settings
+DJANGO_PORT=8001 # PEOPLE_DEPOT runs on 8000
 # To use db.sqlite3, define DATABASE_HOST and DATABASE_PORT with empty values
 # DATABASE_HOST=
 # DATABASE_PORT=
+# USE_SQLITE=True
 # To use postgres, define DATABASE_HOST and DATABASE_PORT with non-empty values
 DATABASE_HOST=localhost
 DATABASE_PORT=5433
 DJANGO_SUPERUSER=kbadmin
 [email protected]
 DJANGO_SUPERUSER_PASSWORD=$DJANGO_SUPERUSER
-USE_SQLITE=True
+USE_SQLITE=False
 
 # PEOPLE_DEPOT_URL="http://localhost:8000"
 # COGNITO_CLIENT_SECRET=...4sq6msq4vf93bdu...
-# PEOPLE_DEPOT_URL=http://localhost:8000
-# PEOPLE_DEPOT_API_SECRET=people-depot-api-secret
-# PEOPLE_DEPOT_API_KEY=people-depot-api-key
 # COGNITO_USER_POOL_NAME=peopledepot
 # COGNITO_AWS_REGION=us-west-2
 # COGNITO_USER_POOL=us-west-2_Fn4rkZpuB
 # COGNITO_CLIENT_ID=...npgi8ul8nfn2undd6ufro...
-# Temporary, west is preferred
-# COGNITO_USER_POOL_NAME=peopledepot
-# COGNITO_AWS_REGION=us-east-2
-# COGNITO_USER_POOL=us-east-2_i2EKGBFG1
+

django_root/core/settings.py

@@ -14,7 +14,6 @@
 import django
 from pathlib import Path
 from django.utils.encoding import smart_str
-
 django.utils.encoding.smart_text = smart_str
 USE_SQLITE_ENV_VALUE = os.environ.get("USE_SQLITE", default="False")
 if type(USE_SQLITE_ENV_VALUE) == bool:

django_root/data/data.py

@@ -44,4 +44,3 @@
 
 
 data[AssetType.__name__] = asset_type
-print(data)

django_root/data/data_utils.py

@@ -6,7 +6,6 @@
 
 class DataUtils:
     def update_model_from_json_file(model, json_file):
-        print(f"Updating {model.__name__} from {json_file}")
         json_file = os.path.join(BASE_DIR, json_file)
         with open(json_file, "r") as f:
             json_data = json.load(f)

django_root/data/migrations/0005_populate_asset_category.py

@@ -4,7 +4,7 @@
 
 
 def run(__apps__, __schema_editor__):
-    print("Loading phases")
+    print("Loading asset categories")
     DataUtils.update_model_from_json_data(AssetCategory)
 
 

docs/overview/Draft-BOP-and-Knowledgebase-Overview.md

@@ -1,12 +1,19 @@
-- The purpose of the BoP project is to create an app to catalog knowledge assets about development practices for Code for America brigades.
-- The purpose of the Knowledgebase app which is in progress is intended to supported BoP functionality.   Additionally, the app supports the generation of web pages from markdown about development practices.   The markdown is stored in the HackForLA Website repo and when generated, added to the "Toolkit" of the HackForLA website.  The web page and source markdown are also content asset which would be of interest to HackForLA and potentially other Code for America brigades.
-- Since Knowledgebase is intended to support BOP, the two projects are being combined.
-- MVP for Phase 1 will only support the cataloging of content described in the first bullet.  Generation of HackForLA content will be a later phase.
-- Knowledgebase stores content assets and related data in a Postgres or  (for development only) MySQL database.  The data is maintained through the default admin screens in Django.  
-- The Knowledgebase screens were reviewed to see how closely they align with BOP.  The following needs to be added to the Knowledgebase model:
-  - gdoc (badly named) table which was intended to hold all types of content assets will be split into two tables: asset groups and assets.  Most fields will go into asset group. An asset group will have one or more assets associated with it.  Asset table will include title, asset type, and URL at a minimum.
+# BOP Project
+
+The purpose of the BoP project is to catalog knowledge assets / documentation about development practices for organizations or open source communities, starting with Hackfor LA.
+
+# Knowledgebase
+
+## Cataloging
+The purpose of the Knowledgebase app is to support the cataloging of BOP.  Knowledgebase app stores content assets and related data in a Postgres database.  The data is maintained through the default admin screens in Django.  
+
+## Markdown to Google Doc
+Some of the BoP assets will be Google Docs.  The app will supports the generation of web pages from Google docs to markdown which is then used to generate the web pages for the "Toolkit" website.  
+
+
+# Misc
+The Knowledgebase screens were reviewed to see how closely they align with the needs for BOP.  The model:
   - google id is only relevant if the content is used as source for the HackForLA website.  To support parallel development of web page generation this field will need to be included but can be hidden when deployed to production.
-  - a field is needed to indicate this is for / from the HackForLA website, which will be hidden for production.
 - Data will be initially populated from existing google sheets
 - Subsequent updates and additions will be done through the Django admin page.  No APIs need to built for this.
 - Viewing and querying can also be done through Django admin, depending on the complexity of the functional and usability requirements.