Skip to content

Commit aa3f61e

Browse files
Remove gdoc converter (separate repo), update md
1 parent 0416327 commit aa3f61e

File tree

125 files changed

+27
-80646
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+27
-80646
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,28 @@
1-
# Starting People Depot
2-
## Stopping processes running on needed ported
3-
Follow these instructions if 5432, 5433, 8000, or 8001 are used by other applications.
4-
5-
1. If Postgresql is running for another app other than People Depot, kill Postgresql
6-
7-
For Mac
8-
- Stop Postgresql: `brew services stop postgresql`
9-
- If it indicates a specific version was stopped (`Stopping ```postgresql@16```...`),
10-
then stop that version: `brew services stop postgresql@16`
11-
12-
For PC:
13-
- ???
14-
15-
2. Repeat for 5433
16-
3. Kill process running on 8000: `kill -9 (lsof -ti:8000)`
17-
4. Repeat for 8001
18-
5. If you think databases on port 5432 or 5433 were used for a different application, then reinitialize or change where ports are started
19-
20-
## Configure
21-
- From terminal:
22-
```
23-
cd django_root
24-
cp .env.local-example .env.local
25-
```
26-
- If you are using People Depot then check PEOPLE_DEPOT_URL is defined. If not, check that it is commented out.
27-
- If you are using Cognito for login, get values for Cognito variables from a development admin or 1password.com (if
28-
a HackForLA account has been setup). You can also create your own Cognito domain if you want. See ???
29-
30-
## Start People Depot
31-
If you are not using People Depot APIs and don't want to set up replication from People Depot, then skip this section.
32-
33-
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.
34-
35-
## Start Doc Conversion
36-
37-
## Start Knowledgebase
38-
From terminal: `cd django_root`, then `source start-local.sh` or `source start-docker.sh`
1+
# Terminology
2+
- Asset: content accessible through a URL
3+
4+
# Overview
5+
The Knowledgebase server interacts with a Google Doc to Mark Down Server, a People Depot Server, and a HackForLA Website Server. Knowledgebase can work without these servers - the functionality these servers provide will not be available, but everything else will work.
6+
7+
The Knowledgebase server
8+
- maintains and categorize information about
9+
- track status of assets
10+
- generates markdown from assets that are Google docs. This requires a Google Doc to Markdown server.
11+
- uses generated markdown for content for a HackForLA Website Server.
12+
- users, practice areas, and technologies can be replicated from a People Depot server, where People Depot would be the source of truth.
13+
14+
# Servers
15+
- Knowledgebase app is a Django app that connects to a PostGres database.
16+
17+
Knowledgebase can also interact with
18+
- HackForLA website
19+
- technologies: Docker, Jekyll
20+
- PeopleDepot
21+
- technologies: Docker, Python, Django, PostgreSQL, mkdocs, Amazon Cognito
22+
- [People Depot Docs](https://hackforla.github.io/peopledepot/)
23+
- [setting up a development environment](https://hackforla.github.io/peopledepot/contributing/dev_environment/)
24+
- [code](https://github.com/hackforla/peopledepot)
25+
- Google Doc to Markdown Server service: TypeScript and Express
26+
- technologies: Typescript, Express, Google API
27+
- [development setup](https://github.com/hackforla/gdoc-converter/blob/main/CONTRIBUTING.md)
3928

File renamed without changes.

utils/findit.sh

Lines changed: 0 additions & 4 deletions
This file was deleted.

utils/gdocs2md/.vscode/launch.json

Lines changed: 0 additions & 74 deletions
This file was deleted.

utils/gdocs2md/.vscode/settings.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

utils/gdocs2md/archive/constants.js

Lines changed: 0 additions & 52 deletions
This file was deleted.

utils/gdocs2md/archive/convert.tmp

Lines changed: 0 additions & 97 deletions
This file was deleted.

utils/gdocs2md/archive/convert.ts

Lines changed: 0 additions & 89 deletions
This file was deleted.

0 commit comments

Comments
 (0)