-
-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #792 from hotosm/docs/wiki-to-gh-pages
Update Wiki --> GH Pages
- Loading branch information
Showing
46 changed files
with
255,015 additions
and
1,986 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
### copy to .env and set variables | ||
|
||
### ODK Central ### | ||
ODK_CENTRAL_VERSION=v2023.2.1 | ||
ODK_CENTRAL_URL=https://central-proxy | ||
ODK_CENTRAL_USER=[email protected] | ||
ODK_CENTRAL_PASSWD=fmtm | ||
|
@@ -16,12 +17,12 @@ FRONTEND_MAP_URL=127.0.0.1:8081 | |
# API_PREFIX=/api | ||
|
||
### OSM ### | ||
OSM_CLIENT_ID= | ||
OSM_CLIENT_SECRET= | ||
OSM_CLIENT_ID=xxx | ||
OSM_CLIENT_SECRET=xxx | ||
OSM_URL=https://www.openstreetmap.org | ||
OSM_SCOPE=read_prefs | ||
OSM_LOGIN_REDIRECT_URI=http://127.0.0.1:8080/osmauth/ | ||
OSM_SECRET_KEY= | ||
OSM_SECRET_KEY=xxx | ||
|
||
### Database (optional) ### | ||
CENTRAL_DB_HOST=central-db | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
name: Publish Docs | ||
|
||
on: | ||
push: | ||
paths: | ||
- docs/** | ||
- src/** | ||
- mkdocs.yml | ||
branches: [main] | ||
# Allow manual trigger (workflow_dispatch) | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
build_doxygen: | ||
name: Build Doxygen Docs | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Setup Doxygen | ||
run: sudo apt-get update && sudo apt-get install -y doxygen | ||
|
||
- name: Write cache | ||
uses: actions/cache@v3 | ||
with: | ||
path: | | ||
.cache | ||
docs/apidocs | ||
docs/openapi.json | ||
key: doc-build-${{ env.cache_id }} | ||
|
||
- name: Build Doxygen Docs | ||
run: | | ||
cd docs | ||
doxygen | ||
build_openapi_json: | ||
name: Build OpenAPI | ||
runs-on: ubuntu-latest | ||
container: ghcr.io/hotosm/fmtm/backend:ci-main | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Read cache | ||
uses: actions/cache@v3 | ||
with: | ||
path: | | ||
.cache | ||
docs/apidocs | ||
docs/openapi.json | ||
key: doc-build-${{ env.cache_id }} | ||
restore-keys: | | ||
doc-build- | ||
- name: Build OpenAPi JSON | ||
run: | | ||
cd src/backend | ||
python ../../scripts/gen_openapi_json.py -o ../../docs/openapi.json | ||
publish_docs: | ||
name: Publish Docs | ||
runs-on: ubuntu-latest | ||
container: ghcr.io/hotosm/fmtm/backend:ci-main | ||
needs: [build_doxygen, build_openapi_json] | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Read cache | ||
uses: actions/cache@v3 | ||
with: | ||
path: | | ||
.cache | ||
docs/apidocs | ||
docs/openapi.json | ||
key: doc-build-${{ env.cache_id }} | ||
restore-keys: | | ||
doc-build- | ||
- name: Publish | ||
run: | | ||
cd src/backend | ||
mkdocs gh-deploy --config-file=../../mkdocs.yml --force |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -72,4 +72,6 @@ src/frontend/node_modules | |
|
||
# pdm | ||
**/.pdm.toml | ||
**/pdm.toml | ||
**/.pdm-python | ||
**/__pypackages__ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Code of conduct | ||
# 📜 Code of conduct | ||
|
||
(The latest version can be found at <https://www.hotosm.org/code-of-conduct>) | ||
|
||
|
@@ -80,4 +80,4 @@ As a first measure, it is preferable to work out issues directly with the people | |
|
||
- Contact the HOT Community Partnerships Manager. | ||
|
||
When these informal processes fail, or when a situation warrants an immediate response by HOT, you can evoke the **HOT Policy and Code of Conduct Complaint Handling Process**. This process was adopted by HOT Voting Members in 2016 to provide a more formal means of enforcement for our community standards. You start it by emailing [[email protected]](mailto:[email protected]) with a description of your complaint, your name, and the name of the offending party. All complaints will be considered confidential. The full process is described [here](https://docs.google.com/document/d/1xb-SPADtSbgwl6mAgglHMPHpknt-E7lKRoIcSbW431A/edit) | ||
When these informal processes fail, or when a situation warrants an immediate response by HOT, you can evoke the **HOT Policy and Code of Conduct Complaint Handling Process**. This process was adopted by HOT Voting Members in 2016 to provide a more formal means of enforcement for our community standards. You start it by emailing [[email protected]](mailto:[email protected]) with a description of your complaint, your name, and the name of the offending party. All complaints will be considered confidential. The full process is described [here](https://docs.google.com/document/d/1xb-SPADtSbgwl6mAgglHMPHpknt-E7lKRoIcSbW431A/edit) . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../CODE_OF_CONDUCT.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../CONTRIBUTING.md |
Oops, something went wrong.