Skip to content

Commit e6934eb

Browse files
Minor changes to MD
1 parent 34a799a commit e6934eb

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

CONTRIBUTING.md

Whitespace-only changes.

NOTES.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,9 @@ The API user must pick a version status - draft, in review, or approved - for an
4949
# Features
5050
## Google Document Features
5151
# Technical Documentation
52-
# Technical Implementation
5352

53+
# Technical Implementation
54+
## Maintenance with Django
5455
## People Depot Replication with SSO
5556

5657
The Knowledgebase replicates the People Depot table when the user logs in. This is the log in flow:
@@ -67,7 +68,7 @@ The Knowledgebase replicates the People Depot table when the user logs in. This
6768
3.2 user logs in with username and password
6869
3.3 Knowledgebase calls People Depot /login API to validate username and password against People Depot
6970
3.4 Knowledgebase creates a token
70-
5. Knowledgebase redirects the user to the /sync url. This is configured in the LOGIN_REDIRECT_URL environment variable.
71+
5. Knowledgebase redirects the user to the /sync url. This is configured in the dLOGIN_REDIRECT_URL environment variable.
7172
6. The view associated with the /sync url, `sync_view()`, calls `update_all_from_pd()`, which:
7273
6.1 calls `update_user_profile_from_pd()`, which:
7374
6.1.1 gets current user data from `https://<people depot server>/profile` with token in header
@@ -79,7 +80,7 @@ The Knowledgebase replicates the People Depot table when the user logs in. This
7980
6.3.1 gets practice area data from `https://<people depot server>/practice-areas` (without a token)
8081
6.3.2 creates or updates the practice area records
8182

82-
## Servers Knowledgebase interacts with
83+
## Related Servers
8384

8485
- Google doc conversion server. It converts a Google doc into markdown. We have written the backend for this server in javascript.
8586
- Jekyll server. The Jekyll server converts the markdown to HTML for the Hack for LA website.

django_root/.env.local-example

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
DJANGO_SETTINGS_MODULE=core.settings
22
# To use db.sqlite3, define DATABASE_HOST and DATABASE_PORT with empty values
3-
DATABASE_HOST=
4-
DATABASE_PORT=
3+
# DATABASE_HOST=
4+
# DATABASE_PORT=
55
# To use postgres, define DATABASE_HOST and DATABASE_PORT with non-empty values
6-
# DATABASE_HOST=localhost
7-
# DATABASE_PORT=5433
6+
DATABASE_HOST=localhost
7+
DATABASE_PORT=5433
88
DJANGO_SUPERUSER=kbadmin
99
1010
DJANGO_SUPERUSER_PASSWORD=$DJANGO_SUPERUSER

0 commit comments

Comments
 (0)