diff --git a/.github/workflows/BuildMKDocsAndPublishToGithubPages.yml b/.github/workflows/BuildMKDocsAndPublishToGithubPages.yml index b5a79de68..2dad064ef 100644 --- a/.github/workflows/BuildMKDocsAndPublishToGithubPages.yml +++ b/.github/workflows/BuildMKDocsAndPublishToGithubPages.yml @@ -11,7 +11,7 @@ # __date__ = '13/06/2023' # __copyright__ = ('Copyright 2023, Unicef') -name: 📖 Build MKDocs And Publish To Github Pages.yml +name: 📖 Documentation on: push: branches: @@ -21,6 +21,7 @@ on: paths: - ".github/workflows/BuildMKDocsAndPublishToGithubPages.yml" - "docs/**.md" + - "docs/**.py" - "docs/assets/**" # Allow manually running in the actions tab workflow_dispatch: @@ -46,4 +47,4 @@ jobs: # The token is automatically generated by the GH Action GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} CONFIG_FILE: docs/mkdocs.yml - REQUIREMENTS: docs/requirements.txt + REQUIREMENTS: docs/requirements.txt \ No newline at end of file diff --git a/.github/workflows/CompileMKDocsToPDF.yml b/.github/workflows/CompileMKDocsToPDF.yml deleted file mode 100644 index 216d0766d..000000000 --- a/.github/workflows/CompileMKDocsToPDF.yml +++ /dev/null @@ -1,51 +0,0 @@ -# GeoSight is UNICEF's geospatial web-based business intelligence platform. -# -# Contact : geosight-no-reply@unicef.org -# -# .. note:: This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation; either version 3 of the License, or -# (at your option) any later version. -# -# __author__ = 'irwan@kartoza.com' -# __date__ = '13/06/2023' -# __copyright__ = ('Copyright 2023, Unicef') - -name: 📔 Compile MKDocs to PDF -# This workflow is triggered on pushes to the repository. -on: - push: - branches: - - main - - docs - # Paths can be used to only trigger actions when you have edited certain files, such as a file within the /docs directory - paths: - - ".github/workflows/CompileMKDocsToPDF.yml" - - "docs/**.md" - - "docs/assets/**" - # Allow manually running in the actions tab - workflow_dispatch: - -jobs: - generatepdf: - name: Build PDF - runs-on: ubuntu-latest - steps: - - name: Checkout 🛒 - uses: actions/checkout@v2 - - name: Create Mkdocs Config 🚀 - working-directory: ./docs - run: ./create-mkdocs-pdf-config.sh - - name: Build PDF 📃 - uses: kartoza/mkdocs-deploy-build-pdf@master - # Uses orzih's mkdocs PDF builder - # https://github.com/orzih/mkdocs-with-pdf - env: - CONFIG_FILE: docs/mkdocs.yml - EXTRA_PACKAGES: build-base - #REQUIREMENTS: folder/requirements.txt - - name: Upload PDF Artifact ⚡ - uses: actions/upload-artifact@v3 - with: - name: docs - path: docs/pdfs diff --git a/.gitignore b/.gitignore index 50e17a4e1..41f4af93b 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,7 @@ django_project/.env #direnv for docs building docs/.direnv +# Autogenerated api docs +docs/src/developer/manual/*.md + +*.swp diff --git a/README.md b/README.md index 3d806fd01..8d32d297d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ A **project** (dashboard) is the most important feature of GeoSight. Projects co [![Tests](https://github.com/unicef-drp/GeoSight-OS/workflows/Tests/badge.svg)](https://github.com/unicef-drp/GeoSight-OS/actions/workflows/tests.yaml) [![Flake8](https://github.com/unicef-drp/GeoSight-OS/workflows/Flake8/badge.svg)](https://github.com/unicef-drp/GeoSight-OS/actions/workflows/flake8.yml) -[![Documentation](https://github.com/unicef-drp/GeoSight-OS/workflows/Documentation/badge.svg)](https://unicef-drp.github.io/GeoSight/) +[![Documentation](https://github.com/unicef-drp/GeoSight-OS/actions/workflows/BuildMKDocsAndPublishToGithubPages.yml/badge.svg)](https://unicef-drp.github.io/GeoSight-OS/) ### Production diff --git a/docs/create-uuid.py b/docs/create-uuid.py new file mode 100755 index 000000000..7cd8a6b2e --- /dev/null +++ b/docs/create-uuid.py @@ -0,0 +1,5 @@ +#! /usr/bin/env python + +import shortuuid +uuid = shortuuid.uuid() +print (uuid) diff --git a/docs/default.nix b/docs/default.nix index 22b486483..5a674b9fd 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -32,6 +32,7 @@ in pkgs.mkShell rec { libxslt libzip zlib + gnused httplz # for serving up the static site while testing ]; diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml index f16c7db01..e771b24dd 100644 --- a/docs/mkdocs-base.yml +++ b/docs/mkdocs-base.yml @@ -35,16 +35,13 @@ markdown_extensions: emoji_generator: !!python/name:materialx.emoji.to_svg emoji_index: !!python/name:materialx.emoji.twemoji - nav: - Home: - index.md - About: about/index.md - - Contributing: - - about/contributing.md - - Commit Messages: about/documentation/commit-message-convention.md - - Pull Request Template: about/documentation/pull-request-template.md + - Contributing: about/contributing.md - Code of Conduct: about/code-of-conduct.md + - Running Instances: about/running-instances.md - Users: - Overview: - user/index.md @@ -53,7 +50,6 @@ nav: - Guide: - user/guide/index.md - Disclaimer: about/disclaimer.md - - Credits: about/credits.md - License: about/license.md - Manual: - user/manual/index.md @@ -68,57 +64,30 @@ nav: - Developers: - Overview: - developer/index.md - - Guide: - - developer/guide/index.md - - Project Prerequisites: developer/guide/project-prerequisites.md - - IDE to Use: developer/guide/ide-to-use.md - - Checking Out The Code: developer/guide/checking-out-the-code.md - - Building/Compiling Code: developer/guide/building-compiling-code.md - - Running Instances: developer/guide/running-instances.md - - Setup: - - developer/guide/setup/index.md - - Installation: - - Preparation: developer/guide/setup/installation/preparation.md - - Project setup: developer/guide/setup/installation/project-setup.md - - Development setup: - - Overview: developer/guide/setup/installation/development-setup/index.md - - Using pycharm: developer/guide/setup/installation/development-setup/pycharm.md - - Road Map: developer/guide/setup/roadmap.md - - Configuration: - - Geography: developer/guide/setup/configuration/geography.md - - Indicator: developer/guide/setup/configuration/indicator.md - - Instances: developer/guide/setup/configuration/instances.md - - Layer: developer/guide/setup/configuration/layer.md - - Navigation Link: developer/guide/setup/configuration/navigation-link.md - - Preferences: developer/guide/setup/configuration/preferences.md - - Program Intervention: developer/guide/setup/configuration/program-intervention.md - - Scenario: developer/guide/setup/configuration/scenario.md - - User: developer/guide/setup/configuration/user.md - - Building/Compiling Code: developer/guide/building-compiling-code.md - - Checking Out The Code: developer/guide/checking-out-the-code.md - - Developer Workflows: developer/guide/developer-workflows.md - - IDE to Use: developer/guide/ide-to-use.md - - Running Instances: developer/guide/running-instances.md - - - Architecture: - - developer/architecture/index.md - - Documentation: - - developer/documentation/index.md - - Manual: - - developer/manual/index.md - - License: about/license.md - API: - developer/api/index.md - - API Manual: developer/api/api.md - - API Settings: developer/api/api_settings.md - - Design: - - developer/design/index.md - - DevOps: - - Overview: - - devops/index.md + - Guide: developer/api/guide/index.md + - Reference: developer/api/manual/index.md - Guide: - - devops/guide/index.md - - Tutorial 1: devops/guide/tutorial1.md + - Overview: developer/guide/index.md + - Architecture: developer/guide/architecture.md + - Design: developer/guide/design.md + - Prerequisites: developer/guide/project-prerequisites.md + - IDE Setup: developer/guide/ide-setup.md + - Cloning: developer/guide/checking-out-the-code.md + - Configuration: developer/guide/configuration.md + - Building: developer/guide/building.md + - Workflows: developer/guide/developer-workflows.md + - Road Map: developer/guide/roadmap.md + # Pages to render but exclude from Nav + - "": developer/guide/templates/commit-message-convention.md + - "": developer/guide/templates/pull-request-template.md + - Documentation: developer/documentation/index.md - Manual: - - devops/manual/index.md + - developer/manual/index.md + - License: about/license.md + - DevOps: + - devops/index.md + - Guide: devops/guide/index.md + - Manual: devops/manual/index.md diff --git a/docs/mkdocs-html.yml b/docs/mkdocs-html.yml index e21ee80a6..840ce205c 100644 --- a/docs/mkdocs-html.yml +++ b/docs/mkdocs-html.yml @@ -65,6 +65,32 @@ extra_javascript: # Needed for the hooks below to work plugins: - search + - git-revision-date-localized + - mkdocs-video + - mkdocstrings: + handlers: + python: + paths: [../django_project] + import: + - https://docs.python.org/3/objects.inv + - https://mkdocstrings.github.io/autorefs/objects.inv + options: + # Lots of other nice options can be found at + # https://mkdocstrings.github.io/python/usage/ + docstring_style: sphinx + heading_level: 2 + show_bases: true + show_signature: true + separate_signature: true + show_signature_annotations: true + show_source: true + show_root_heading: true + show_root_full_path: true + show_root_members_full_path: true + merge_init_into_class: true + docstring_options: + ignore_init_summary: false + - redirects: redirect_maps: #see https://github.com/mkdocs/mkdocs-redirects/tree/master#using @@ -82,6 +108,7 @@ plugins: - user/index.md - administrator/index.md - developer/index.md + - developer/manual/*.md - devops/index.md restart_increment_after: - second_section.md @@ -90,4 +117,6 @@ plugins: # see also hook.py and https://github.com/squidfunk/mkdocs-material/discussions/3758#discussioncomment-4397373 # Note that although the above link implies you can use UUIDs, you have to use numeric IDS not UUIDS hooks: - - ./hook.py + - ./uuid_redirects_hook.py + - ./python_manual_hook.py + diff --git a/docs/python_manual_hook.py b/docs/python_manual_hook.py new file mode 100755 index 000000000..b23c6df28 --- /dev/null +++ b/docs/python_manual_hook.py @@ -0,0 +1,43 @@ +import logging +import mkdocs.plugins +import os + +log = logging.getLogger('mkdocs') + +@mkdocs.plugins.event_priority(-50) + + +def on_startup(command, dirty): + + + template = """ +--- +title: Automatically Generated Python Documentation +summary: DO NOT EDIT THIS FILE MANUALLY : It is created during the mkdocs build process +date: 2023-08-03 +--- + +# Python Reference Manual +""" + ignore_list = [ + "__init__", + "migrations", + "tests"] + + for root, dirs, files in os.walk("../django_project"): + for file in files: + file = os.path.join(root, file) + if file.endswith(".py"): + ignored = False; + for item in ignore_list: + if item in file: + ignored = True; + #print (item, file, ignored) + if not ignored: + file = file.replace("../django_project/", "::: ") + file = file.replace("/", ".") + file = file.replace(".py", "") + template = template + file + "\n" + file = open("docs/src/developer/manual/index.md","wt") + file.write(template) + file.close() diff --git a/docs/requirements.txt b/docs/requirements.txt index cfafa4f1a..462389c26 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -7,3 +7,8 @@ mkdocstrings-python mkdocs-video mkdocs-redirects mkdocs-enumerate-headings-plugin +mkdocs-git-revision-date-localized-plugin +# needed for the create-uuid.py helper script +shortuuid +# Needed for mkdocstrings python documentation generator +black diff --git a/docs/src/about/contributing.md b/docs/src/about/contributing.md index c34142306..a2988bce2 100644 --- a/docs/src/about/contributing.md +++ b/docs/src/about/contributing.md @@ -1,16 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # Contributing to GeoSight @@ -107,7 +106,7 @@ If you are adding new commands or features, they must include tests. If you are changing functionality, update the tests if you need to. #### Commit -Follow our [commit message conventions](./documentation/commit-message-convention.md). +Follow our [commit message conventions](../developer/guide/templates/commit-message-convention.md). ### Yes! Pull request @@ -126,7 +125,7 @@ Follow other PR title format on below. #### Description If it has related issues, add links to the issues(like `#123`) in the description. -Fill in the [Pull Request Template](./documentation/pull-request-template.md) by check your case. +Fill in the [Pull Request Template](../developer/guide/templates/pull-request-template.md) by check your case. ## Code of Conduct diff --git a/docs/src/about/credits.md b/docs/src/about/credits.md deleted file mode 100644 index 8dc9c322e..000000000 --- a/docs/src/about/credits.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Project Credits - \ No newline at end of file diff --git a/docs/src/about/disclaimer.md b/docs/src/about/disclaimer.md index 024d6ea17..7a0ded56c 100644 --- a/docs/src/about/disclaimer.md +++ b/docs/src/about/disclaimer.md @@ -1,16 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # Disclaimer diff --git a/docs/src/about/documentation/commit-message-convention.md b/docs/src/about/documentation/commit-message-convention.md deleted file mode 100644 index 0477bcd5f..000000000 --- a/docs/src/about/documentation/commit-message-convention.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Commit Message Convention - \ No newline at end of file diff --git a/docs/src/about/documentation/pull-request-template.md b/docs/src/about/documentation/pull-request-template.md deleted file mode 100644 index 61662a3a1..000000000 --- a/docs/src/about/documentation/pull-request-template.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Pull Request Template - \ No newline at end of file diff --git a/docs/src/about/index.md b/docs/src/about/index.md index bbc2aba2d..a2403fece 100644 --- a/docs/src/about/index.md +++ b/docs/src/about/index.md @@ -1,16 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # About diff --git a/docs/src/about/running-instances.md b/docs/src/about/running-instances.md new file mode 100644 index 000000000..041c6291c --- /dev/null +++ b/docs/src/about/running-instances.md @@ -0,0 +1,14 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + +# Examples of Running Instances diff --git a/docs/src/administrator/guide/index.md b/docs/src/administrator/guide/index.md index c2a389fee..a638e5090 100644 --- a/docs/src/administrator/guide/index.md +++ b/docs/src/administrator/guide/index.md @@ -1,17 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # Administrator Guide diff --git a/docs/src/administrator/index.md b/docs/src/administrator/index.md index 3b34e9e7d..ccb9cde28 100644 --- a/docs/src/administrator/index.md +++ b/docs/src/administrator/index.md @@ -1,19 +1,22 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "_author_ = 'irwan@kartoza.com'" -[//]: # "_date_ = '13/06/2023'" -[//]: # "_copyright_ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # For Administrators This is the homepage for all administrator related documentation. -![Screenshot](../img/screenshot.png) +The content is divided into two sections: + +* The [user guide](guide/index.md), which describes common workflows for system administrators in a tutorial format. +* The [user manual](manual/index.md), which describes each page of the admin user interface and what the various options on that page do. diff --git a/docs/src/administrator/manual/index.md b/docs/src/administrator/manual/index.md index 806686462..ec786a497 100644 --- a/docs/src/administrator/manual/index.md +++ b/docs/src/administrator/manual/index.md @@ -1,16 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # Administrator Reference Manual diff --git a/docs/src/developer/api/api.md b/docs/src/developer/api/api.md deleted file mode 100644 index 39dc56803..000000000 --- a/docs/src/developer/api/api.md +++ /dev/null @@ -1,14 +0,0 @@ -# API Documentation - - -## API Manual - - -[Swagger API Manual]() - -## Tutorials - - -### API Workflow 1 - -### API Workflow 2 diff --git a/docs/src/developer/api/api_settings.md b/docs/src/developer/api/api_settings.md deleted file mode 100644 index d637e8fe3..000000000 --- a/docs/src/developer/api/api_settings.md +++ /dev/null @@ -1,25 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Settings - - diff --git a/docs/src/developer/api/guide/index.md b/docs/src/developer/api/guide/index.md new file mode 100644 index 000000000..5c7b3ce74 --- /dev/null +++ b/docs/src/developer/api/guide/index.md @@ -0,0 +1,15 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + +# API Guide + diff --git a/docs/src/developer/api/index.md b/docs/src/developer/api/index.md index 39dc56803..c06d8a8da 100644 --- a/docs/src/developer/api/index.md +++ b/docs/src/developer/api/index.md @@ -1,14 +1,20 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + # API Documentation +This is the homepage for all API related documentation. -## API Manual - - -[Swagger API Manual]() - -## Tutorials - - -### API Workflow 1 +* The [api guide](./guide/index.md), which describes common workflows for using the restful API. +* The [api manual](./manual/index.md), which describes each API endpoint and its parameters, return values etc. This section is autogenerated. -### API Workflow 2 diff --git a/docs/src/developer/api/manual/index.md b/docs/src/developer/api/manual/index.md new file mode 100644 index 000000000..b0d5c88fc --- /dev/null +++ b/docs/src/developer/api/manual/index.md @@ -0,0 +1 @@ +# API Reference diff --git a/docs/src/developer/architecture/index.md b/docs/src/developer/architecture/index.md deleted file mode 100644 index 439cf18fd..000000000 --- a/docs/src/developer/architecture/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# System Architecture - - -## Frameworks Used - -## High-level System Architecture - -## Data Model diff --git a/docs/src/developer/design/index.md b/docs/src/developer/design/index.md deleted file mode 100644 index ce755975f..000000000 --- a/docs/src/developer/design/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# Design - - -## Design Sheet - -## Wire-frame Model - \ No newline at end of file diff --git a/docs/src/developer/documentation/img/dev-docs-change-branch.png b/docs/src/developer/documentation/img/dev-docs-change-branch.png new file mode 100644 index 000000000..752732dd8 Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-change-branch.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-fork-repo-1.png b/docs/src/developer/documentation/img/dev-docs-fork-repo-1.png new file mode 100644 index 000000000..5ddd56306 Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-fork-repo-1.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-fork-repo-2.png b/docs/src/developer/documentation/img/dev-docs-fork-repo-2.png new file mode 100644 index 000000000..05239ce62 Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-fork-repo-2.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-pull-request-1.png b/docs/src/developer/documentation/img/dev-docs-pull-request-1.png new file mode 100644 index 000000000..cb7e382db Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-pull-request-1.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-pull-request-2.png b/docs/src/developer/documentation/img/dev-docs-pull-request-2.png new file mode 100644 index 000000000..4af07d930 Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-pull-request-2.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-web-editor-1.png b/docs/src/developer/documentation/img/dev-docs-web-editor-1.png new file mode 100644 index 000000000..43adf544a Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-web-editor-1.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-web-editor-2.png b/docs/src/developer/documentation/img/dev-docs-web-editor-2.png new file mode 100644 index 000000000..56f1898b5 Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-web-editor-2.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-web-editor-3.png b/docs/src/developer/documentation/img/dev-docs-web-editor-3.png new file mode 100644 index 000000000..823842b95 Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-web-editor-3.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-web-editor-4.png b/docs/src/developer/documentation/img/dev-docs-web-editor-4.png new file mode 100644 index 000000000..15c97f9e6 Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-web-editor-4.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-web-editor-5.png b/docs/src/developer/documentation/img/dev-docs-web-editor-5.png new file mode 100644 index 000000000..bfb1e6d82 Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-web-editor-5.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-web-editor-6.png b/docs/src/developer/documentation/img/dev-docs-web-editor-6.png new file mode 100644 index 000000000..702817b1f Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-web-editor-6.png differ diff --git a/docs/src/developer/documentation/img/dev-docs-web-editor-7.png b/docs/src/developer/documentation/img/dev-docs-web-editor-7.png new file mode 100644 index 000000000..991013e8e Binary files /dev/null and b/docs/src/developer/documentation/img/dev-docs-web-editor-7.png differ diff --git a/docs/src/developer/guide/setup/img/naming-convention.README b/docs/src/developer/documentation/img/naming-convention.README similarity index 100% rename from docs/src/developer/guide/setup/img/naming-convention.README rename to docs/src/developer/documentation/img/naming-convention.README diff --git a/docs/src/developer/documentation/index.md b/docs/src/developer/documentation/index.md index 26e33711e..1e724308a 100644 --- a/docs/src/developer/documentation/index.md +++ b/docs/src/developer/documentation/index.md @@ -1,14 +1,125 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + # Documentation - +## Organisation + +The documentation is organised in the following structure: + +``` +src +├── index.md +├── about +│   ├── index.md +│   ├── code-of-conduct.md +│   ├── contributing.md +│   ├── credits.md +│   ├── disclaimer.md +│   └── license.md +├── administrator +│   ├── index.md +│   ├── guide +│   └── manual +│   ├── data +│   └── index.md +├── developer +│   ├── index.md +│   ├── guide +│   │   ├── api-guide +│   │   └── api-reference +│   ├── documentation +│   ├── guide +│   │   ├── project-prerequisites.md +│   │   ├── building-compiling-code.md +│   │   ├── checking-out-the-code.md +│   │   ├── vscode.md +│   │   ├── pycharm.md +│   │   ├── developer-workflows.md +│   │   ├── running-instances.md +│   │   └── roadmap.md +│   ├── manual +│   │   ├── index.md +│   │   ├── architecture +│   │   └── design +├── devops +│   ├── index.md +│   ├── guide +│   └── manual +└── user + ├── index.md + ├── guide + ├── manual + └── quickstart +``` ## Code Auto Documentation +This process is now automated when `build-docs-html` is run in a local terminal. + ## How to Make Documentation + ### Adding to Documentation +To start adding to the documentation navigate to the [home page](https://github.com/unicef-drp/GeoSight-OS) of the repository. + +Once on the repository home page, (1) click on Fork +![Fork Repository 1](img/dev-docs-fork-repo-1.png) + +On the next page (1) Make sure your github account is selected as the owner and (2) make sure you untick the option to "**Copy the** `main` **branch only**" as you want to copy all branches. +![Fork Repository 2](img/dev-docs-fork-repo-2.png) + +Once you have forked the repository, (1) click on the drop down menu underneath the repository title and then (2) click on the `docs` branch. +![Change Branch](img/dev-docs-change-branch.png) + +Once you are in the `docs` branch on your fork of the repository, click on `.` on your keyboard. This will open a web editor where you can begin adding to, or editing, the documentation. +![Web Editor 1](img/dev-docs-web-editor-1.png) + +Once the editor loads, you will be greeted by (1) a preview of the project's README.txt. (2) Click on the `docs` directory in the menu on the left, this will expand the directory. To confirm that you are working in the right branch (3) it will say `docs` in the bottom left of the editor. +![Web Editor 2](img/dev-docs-web-editor-2.png) + +Once you have expanded the `docs` directory, (1) click on the `src` directory. All sub-directories within the `src` directory contain the files that become the documentation. Each sub-directory contains an `index.md` file that is required for the building of the documentation and static site. If you add a new sub-directory into any folder it must also contain a populated `index.md` file. +![Wed Editor 3](img/dev-docs-web-editor-3.png) + +Once you have chosen which section of documentation you would like to edit (e.g. user/guide/index.md), click on the file and it will open in the web editor. +![Web Editor 4](img/dev-docs-web-editor-4.png) + +Once you have the file open, you can start adding to the documentation using [Markdown](https://www.markdownguide.org/) syntax. If you need to add images to your documentation, add them to the relative `img` sub-directories following the naming conventions set out in the `naming-convention.README` within the `img` folders. +![Web Editor 5](img/dev-docs-web-editor-5.png) + +When you have completed making additions to (or editing) the documentation, (1) click on the source control tab then (2) click on the `plus` symbol next to the changes you are finished with to stage them, (3) add a commit message that is associated with the work you have done, and the (4) Click on `Commit & Push` +![Web Editor 6](img/dev-docs-web-editor-6.png) + +Once you have committed your changes, (1) Click on the burger menu and then (2) click on `Go To Repository` +![Web Editor 7](img/dev-docs-web-editor-7.png) + +Your fork of the repository will be opened in a new tab within your browser, navigate to that tab. Once there (1) switch to the docs branch, you should see how many commits ahead of the upstream branch you are, then (2) click on `Contribute`-> `Open pull request`. +![Pull Request 1](img/dev-docs-pull-request-1.png) + +On the next screen, (1) give your pull request a meaningful title, (2) give additional details regarding changes made in the larger text box, then (3) click on `Create pull request`. Also ensure you are creating a pull request to the upstream `docs` branch from your `docs` branch. +![Pull Request 2](img/dev-docs-pull-request-2.png) + +Once your pull request is opened you need to wait for it to be merged before you can open a new one. + ### Generating PDFS + + +To generate PDFS, `cd` into `GEOSIGHT-OS/docs` and then run the `build-docs-pdf` in a local terminal ### Generating Static Site + + +To generate PDFS, `cd` into `GEOSIGHT-OS/docs` and then run the `build-docs-html` in a local terminal. +You can then run `mkdocs serve` to generate the static site on your local host, if there is a port conflict you can specify the port using the `-a` flag e.g `mkdocs serve -a 127.0.0.1:8001`. diff --git a/docs/src/developer/guide/architecture.md b/docs/src/developer/guide/architecture.md new file mode 100644 index 000000000..e5a70607f --- /dev/null +++ b/docs/src/developer/guide/architecture.md @@ -0,0 +1,21 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + +# System Architecture + + +## Frameworks Used + +## High-level System Architecture + +## Data Model diff --git a/docs/src/developer/guide/building-compiling-code.md b/docs/src/developer/guide/building-compiling-code.md deleted file mode 100644 index 9d3170974..000000000 --- a/docs/src/developer/guide/building-compiling-code.md +++ /dev/null @@ -1 +0,0 @@ -# Building/Compiling the Code diff --git a/docs/src/developer/guide/building.md b/docs/src/developer/guide/building.md new file mode 100644 index 000000000..f16fbbd01 --- /dev/null +++ b/docs/src/developer/guide/building.md @@ -0,0 +1,14 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + +# Building/Compiling the Code diff --git a/docs/src/developer/guide/checking-out-the-code.md b/docs/src/developer/guide/checking-out-the-code.md index de88328ec..65aad9bd3 100644 --- a/docs/src/developer/guide/checking-out-the-code.md +++ b/docs/src/developer/guide/checking-out-the-code.md @@ -1 +1,14 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + # Checking out the Code diff --git a/docs/src/developer/guide/setup/installation/project-setup.md b/docs/src/developer/guide/configuration.md similarity index 73% rename from docs/src/developer/guide/setup/installation/project-setup.md rename to docs/src/developer/guide/configuration.md index a7b8da280..a30cadfac 100644 --- a/docs/src/developer/guide/setup/installation/project-setup.md +++ b/docs/src/developer/guide/configuration.md @@ -1,16 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # Project Setup diff --git a/docs/src/developer/guide/design.md b/docs/src/developer/guide/design.md new file mode 100644 index 000000000..f3a145806 --- /dev/null +++ b/docs/src/developer/guide/design.md @@ -0,0 +1,20 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + +# Design + + +## Design Sheet + +## Wire-frame Model + \ No newline at end of file diff --git a/docs/src/developer/guide/developer-workflows.md b/docs/src/developer/guide/developer-workflows.md index 333b93aeb..0f04f3a47 100644 --- a/docs/src/developer/guide/developer-workflows.md +++ b/docs/src/developer/guide/developer-workflows.md @@ -1,16 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # Developer Workflows @@ -33,9 +32,9 @@ ### Committing To Project -Follow our [commit message conventions](../../about/documentation/commit-message-convention.md). +Follow our [commit message conventions](./templates/commit-message-convention.md). ### Pull Request Template If it has related issues, add links to the issues(like `#123`) in the description. -Fill in the [Pull Request Template](../../about/documentation/pull-request-template.md) by check your case. +Fill in the [Pull Request Template](./templates/pull-request-template.md) by check your case. diff --git a/docs/src/developer/guide/setup/installation/development-setup/pycharm.md b/docs/src/developer/guide/ide-setup.md similarity index 80% rename from docs/src/developer/guide/setup/installation/development-setup/pycharm.md rename to docs/src/developer/guide/ide-setup.md index 97f49cc1d..9214b02eb 100644 --- a/docs/src/developer/guide/setup/installation/development-setup/pycharm.md +++ b/docs/src/developer/guide/ide-setup.md @@ -1,16 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +---" # Using pycharm diff --git a/docs/src/developer/guide/ide-to-use.md b/docs/src/developer/guide/ide-to-use.md deleted file mode 100644 index ec288897b..000000000 --- a/docs/src/developer/guide/ide-to-use.md +++ /dev/null @@ -1 +0,0 @@ -# IDE to Use For Project diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/1.png b/docs/src/developer/guide/img/1.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/1.png rename to docs/src/developer/guide/img/1.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/10.png b/docs/src/developer/guide/img/10.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/10.png rename to docs/src/developer/guide/img/10.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/11.png b/docs/src/developer/guide/img/11.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/11.png rename to docs/src/developer/guide/img/11.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/12.png b/docs/src/developer/guide/img/12.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/12.png rename to docs/src/developer/guide/img/12.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/13.png b/docs/src/developer/guide/img/13.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/13.png rename to docs/src/developer/guide/img/13.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/2.png b/docs/src/developer/guide/img/2.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/2.png rename to docs/src/developer/guide/img/2.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/3.png b/docs/src/developer/guide/img/3.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/3.png rename to docs/src/developer/guide/img/3.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/4.png b/docs/src/developer/guide/img/4.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/4.png rename to docs/src/developer/guide/img/4.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/5.png b/docs/src/developer/guide/img/5.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/5.png rename to docs/src/developer/guide/img/5.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/6.png b/docs/src/developer/guide/img/6.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/6.png rename to docs/src/developer/guide/img/6.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/7.png b/docs/src/developer/guide/img/7.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/7.png rename to docs/src/developer/guide/img/7.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/8.png b/docs/src/developer/guide/img/8.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/8.png rename to docs/src/developer/guide/img/8.png diff --git a/docs/src/developer/guide/setup/installation/development-setup/img/9.png b/docs/src/developer/guide/img/9.png similarity index 100% rename from docs/src/developer/guide/setup/installation/development-setup/img/9.png rename to docs/src/developer/guide/img/9.png diff --git a/docs/src/developer/guide/index.md b/docs/src/developer/guide/index.md index 25d3601f1..cfacf18ac 100644 --- a/docs/src/developer/guide/index.md +++ b/docs/src/developer/guide/index.md @@ -1,16 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # GeoSight diff --git a/docs/src/developer/guide/project-prerequisites.md b/docs/src/developer/guide/project-prerequisites.md index 9cb57f10e..6a7062259 100644 --- a/docs/src/developer/guide/project-prerequisites.md +++ b/docs/src/developer/guide/project-prerequisites.md @@ -1,11 +1,95 @@ -# Project Prerequisites - +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- -## Programming Languages - +# Preparation -## Hardware Required - +## Dependencies installation -## Operating System - +The project provide **make** command that making setup process easier. +To install make on your machine or virtual box server, do: + +``` +sudo apt install make +``` + +Project has recipe that you can use to run the project in one command. +This recipe needs docker-compose to be able to use it. +To install it, do: + +``` +sudo apt install docker-compose +apt install ca-certificates curl gnup lsb-release +``` + +## Docker installation + +The project needs docker to be able to run it. To install it, please follow below instruction. + +``` +curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg +``` + +On the next prompt line: + +``` +echo \ +"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg]https:download.docker.com/linux/ubuntu \ +$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null +``` + +Run apt update: + +``` +sudo apt-get update +``` + +This will install docker +``` +sudo apt-get install docker-ce-cli containerd.io +``` + +This will check if installation of docker was successful +``` +sudo docker version +``` +And it should return like this + +``` +Client: Docker Engine - Community + Version: 20.10.9 + API version: 1.41 + Go version: go1.16.8 + Git commit: c2ea9bc + Built: Mon Oct 4 16:08:29 2021 + OS/Arch: linux/amd64 + Context: default + Experimental: true + +``` + +### Manage docker as non-root + +This will ensure that the docker can be executed without sudo. +``` +sudo systemctl daemon-reload +sudo systemctl start docker +sudo usermod -a -G $USER +sudo systemctl enable docker +``` + +Verify that you can run docker commands without sudo. +``` +docker run hello-world +``` + +For more information how to install docker, please visit [Install Docker Engine](https://docs.docker.com/engine/install/) \ No newline at end of file diff --git a/docs/src/developer/guide/roadmap.md b/docs/src/developer/guide/roadmap.md new file mode 100644 index 000000000..da1b967c6 --- /dev/null +++ b/docs/src/developer/guide/roadmap.md @@ -0,0 +1,32 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + +# Roadmap + +Like most Open Source Software, this project is an ongoing work in progress. + +This document outlines the various ongoing activities and critical changes +expected to be introduced. + +## Future plans + +- A data model for scenarios instead of pulling in google sheets or similar +- More ingestors for risk data +- Hazard data support with auto aggregation of risk factors such as population + counts etc. +- Single sign on support + +## Considerations + +The current **main** branch is under heavy development and should be considered +unstable. \ No newline at end of file diff --git a/docs/src/developer/guide/running-instances.md b/docs/src/developer/guide/running-instances.md deleted file mode 100644 index 4ae0bb24b..000000000 --- a/docs/src/developer/guide/running-instances.md +++ /dev/null @@ -1 +0,0 @@ -# How to Run Instances diff --git a/docs/src/developer/guide/setup/configuration/geography.md b/docs/src/developer/guide/setup/configuration/geography.md deleted file mode 100644 index a18a3c688..000000000 --- a/docs/src/developer/guide/setup/configuration/geography.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Title - \ No newline at end of file diff --git a/docs/src/developer/guide/setup/configuration/indicator.md b/docs/src/developer/guide/setup/configuration/indicator.md deleted file mode 100644 index a18a3c688..000000000 --- a/docs/src/developer/guide/setup/configuration/indicator.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Title - \ No newline at end of file diff --git a/docs/src/developer/guide/setup/configuration/instances.md b/docs/src/developer/guide/setup/configuration/instances.md deleted file mode 100644 index a18a3c688..000000000 --- a/docs/src/developer/guide/setup/configuration/instances.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Title - \ No newline at end of file diff --git a/docs/src/developer/guide/setup/configuration/layer.md b/docs/src/developer/guide/setup/configuration/layer.md deleted file mode 100644 index a18a3c688..000000000 --- a/docs/src/developer/guide/setup/configuration/layer.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Title - \ No newline at end of file diff --git a/docs/src/developer/guide/setup/configuration/navigation-link.md b/docs/src/developer/guide/setup/configuration/navigation-link.md deleted file mode 100644 index a18a3c688..000000000 --- a/docs/src/developer/guide/setup/configuration/navigation-link.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Title - \ No newline at end of file diff --git a/docs/src/developer/guide/setup/configuration/preferences.md b/docs/src/developer/guide/setup/configuration/preferences.md deleted file mode 100644 index a18a3c688..000000000 --- a/docs/src/developer/guide/setup/configuration/preferences.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Title - \ No newline at end of file diff --git a/docs/src/developer/guide/setup/configuration/program-intervention.md b/docs/src/developer/guide/setup/configuration/program-intervention.md deleted file mode 100644 index a18a3c688..000000000 --- a/docs/src/developer/guide/setup/configuration/program-intervention.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Title - \ No newline at end of file diff --git a/docs/src/developer/guide/setup/configuration/scenario.md b/docs/src/developer/guide/setup/configuration/scenario.md deleted file mode 100644 index a18a3c688..000000000 --- a/docs/src/developer/guide/setup/configuration/scenario.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Title - \ No newline at end of file diff --git a/docs/src/developer/guide/setup/configuration/user.md b/docs/src/developer/guide/setup/configuration/user.md deleted file mode 100644 index a18a3c688..000000000 --- a/docs/src/developer/guide/setup/configuration/user.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Title - \ No newline at end of file diff --git a/docs/src/developer/guide/setup/index.md b/docs/src/developer/guide/setup/index.md deleted file mode 100644 index 3c73ec7d7..000000000 --- a/docs/src/developer/guide/setup/index.md +++ /dev/null @@ -1,17 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Setup - -This document covers how you can set up the project, for production and development environment setup. \ No newline at end of file diff --git a/docs/src/developer/guide/setup/installation/development-setup/index.md b/docs/src/developer/guide/setup/installation/development-setup/index.md deleted file mode 100644 index 34cc96110..000000000 --- a/docs/src/developer/guide/setup/installation/development-setup/index.md +++ /dev/null @@ -1,18 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Development Environment - -This section is for setup development, so we can develop the project and check the changes in runtime. -The sections depend on what interpreter that you use \ No newline at end of file diff --git a/docs/src/developer/guide/setup/installation/preparation.md b/docs/src/developer/guide/setup/installation/preparation.md deleted file mode 100644 index 641e99090..000000000 --- a/docs/src/developer/guide/setup/installation/preparation.md +++ /dev/null @@ -1,96 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Preparation - -## Dependencies installation - -The project provide **make** command that making setup process easier. -To install make on your machine or virtual box server, do: - -``` -sudo apt install make -``` - -Project has recipe that you can use to run the project in one command. -This recipe needs docker-compose to be able to use it. -To install it, do: - -``` -sudo apt install docker-compose -apt install ca-certificates curl gnup lsb-release -``` - -## Docker installation - -The project needs docker to be able to run it. To install it, please follow below instruction. - -``` -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -``` - -On the next prompt line: - -``` -echo \ -"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg]https:download.docker.com/linux/ubuntu \ -$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -Run apt update: - -``` -sudo apt-get update -``` - -This will install docker -``` -sudo apt-get install docker-ce-cli containerd.io -``` - -This will check if installation of docker was successful -``` -sudo docker version -``` -And it should return like this - -``` -Client: Docker Engine - Community - Version: 20.10.9 - API version: 1.41 - Go version: go1.16.8 - Git commit: c2ea9bc - Built: Mon Oct 4 16:08:29 2021 - OS/Arch: linux/amd64 - Context: default - Experimental: true - -``` - -### Manage docker as non-root - -This will ensure that the docker can be executed without sudo. -``` -sudo systemctl daemon-reload -sudo systemctl start docker -sudo usermod -a -G $USER -sudo systemctl enable docker -``` - -Verify that you can run docker commands without sudo. -``` -docker run hello-world -``` - -For more information how to install docker, please visit [Install Docker Engine](https://docs.docker.com/engine/install/) \ No newline at end of file diff --git a/docs/src/developer/guide/setup/roadmap.md b/docs/src/developer/guide/setup/roadmap.md deleted file mode 100644 index 310f5d74b..000000000 --- a/docs/src/developer/guide/setup/roadmap.md +++ /dev/null @@ -1,33 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# Roadmap - -Like most Open Source Software, this project is an ongoing work in progress. - -This document outlines the various ongoing activities and critical changes -expected to be introduced. - -## Future plans - -- A data model for scenarios instead of pulling in google sheets or similar -- More ingestors for risk data -- Hazard data support with auto aggregation of risk factors such as population - counts etc. -- Single sign on support - -## Considerations - -The current **main** branch is under heavy development and should be considered -unstable. \ No newline at end of file diff --git a/docs/src/developer/guide/templates/commit-message-convention.md b/docs/src/developer/guide/templates/commit-message-convention.md new file mode 100644 index 000000000..0cfb3bd01 --- /dev/null +++ b/docs/src/developer/guide/templates/commit-message-convention.md @@ -0,0 +1,15 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + +# Commit Message Convention + \ No newline at end of file diff --git a/docs/src/developer/guide/templates/pull-request-template.md b/docs/src/developer/guide/templates/pull-request-template.md new file mode 100644 index 000000000..1332a13e1 --- /dev/null +++ b/docs/src/developer/guide/templates/pull-request-template.md @@ -0,0 +1,15 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + +# Pull Request Template + \ No newline at end of file diff --git a/docs/src/developer/index.md b/docs/src/developer/index.md index 37c8536e3..38a10064a 100644 --- a/docs/src/developer/index.md +++ b/docs/src/developer/index.md @@ -1,19 +1,23 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "_author_ = 'irwan@kartoza.com'" -[//]: # "_date_ = '13/06/2023'" -[//]: # "_copyright_ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # For Developers This is the homepage for all developer related documentation. -![Screenshot](../img/screenshot.png) +* The [developer guide](guide/index.md), which describes common workflows for developers in a tutorial format. This includes instructions on how to set up your developer environment, check out the code, run it locally etc. +* The [developer manual](manual/index.md), which describes each python module and its classes, functions etc. This section is autogenerated. +* The [api guide](api/guide/index.md), which describes common workflows for using the restful API. +* The [api manual](api/manual/index.md), which describes each API endpoint and its parameters, return values etc. This section is autogenerated. + diff --git a/docs/src/developer/manual/README.txt b/docs/src/developer/manual/README.txt new file mode 100644 index 000000000..98a8561af --- /dev/null +++ b/docs/src/developer/manual/README.txt @@ -0,0 +1,16 @@ + _ _ _ ____ _ +| \ | | ___ | |_ __ _ ___ | __ ) ___ _ __ __ _ ___ | | +| \| |/ _ \| __/ _` |/ _ \ | _ \ / _ \ '_ \ / _` |/ _ \ | | +| |\ | (_) | || (_| | __/ | |_) | __/ | | | (_| | __/ |_| +|_| \_|\___/ \__\__,_|\___| |____/ \___|_| |_|\__,_|\___| (_) + +IMPORTANT: DO NOT EDIT FILES IN THIS FOLDER BY HAND! + +The files in this folder will be generated by the script in + +docs/update_python_manual.py + +All markdown files in this folder will also be under .gitignore. + +Tim Sutton +10 August 2023 diff --git a/docs/src/developer/manual/index.md b/docs/src/developer/manual/index.md deleted file mode 100644 index 3ff080fe7..000000000 --- a/docs/src/developer/manual/index.md +++ /dev/null @@ -1,21 +0,0 @@ -# Developer Reference Manual - - - -## Setting up the Development Environment - -## Coding Conventions - -## Contributor/Contribution Guidelines - - -## Project SCRUM - - -## How to Test Local Instance - -### Adapting tests for later down pipeline - -## License - -[Project License]() diff --git a/docs/src/devops/guide/index.md b/docs/src/devops/guide/index.md index 4f8a32b46..597348929 100644 --- a/docs/src/devops/guide/index.md +++ b/docs/src/devops/guide/index.md @@ -1,7 +1,17 @@ -# DevOps Tutorial +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + +# DevOps Guide -## Tutorial 1 - -[link to tutorial 1](tutorial1.md) \ No newline at end of file diff --git a/docs/src/devops/guide/tutorial1.md b/docs/src/devops/guide/tutorial1.md deleted file mode 100644 index a05ee30bf..000000000 --- a/docs/src/devops/guide/tutorial1.md +++ /dev/null @@ -1,17 +0,0 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" - -# DevOps Tutorial 1 - - diff --git a/docs/src/devops/index.md b/docs/src/devops/index.md index 28a7dd871..87790508e 100644 --- a/docs/src/devops/index.md +++ b/docs/src/devops/index.md @@ -1,18 +1,22 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # DevOps Documentation This section contains all documentation relevant to DevOps procedures. + +The devops content is divided into three sections: + +* The [devops guide](guide/index.md), which describes common workflows for deployment and management of running instances in a tutorial format. +* The [devops manual](manual/index.md), which provides links and references to deployment configuration files, frameworks and deployment systems used etc. diff --git a/docs/src/devops/manual/index.md b/docs/src/devops/manual/index.md index 0752ca305..357772e9c 100644 --- a/docs/src/devops/manual/index.md +++ b/docs/src/devops/manual/index.md @@ -1,3 +1,16 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + # DevOps Documentation diff --git a/docs/src/developer/manual/img/naming-convention.README b/docs/src/img/naming-convention.README similarity index 100% rename from docs/src/developer/manual/img/naming-convention.README rename to docs/src/img/naming-convention.README diff --git a/docs/src/index.md b/docs/src/index.md index 7a56689c8..963a46744 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -8,7 +8,7 @@ some_url: https://github.com/unicef-drp/GeoSight-OS copyright: Copyright 2023, Unicef contact: geosight-no-reply@unicef.org license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. -context_id: 1234 +context_id: V4cVEFd2TmwYJVb5HvWRwa --- # GeoSight diff --git a/docs/src/user/guide/index.md b/docs/src/user/guide/index.md index 6f00e3fa3..f9e0e54e6 100644 --- a/docs/src/user/guide/index.md +++ b/docs/src/user/guide/index.md @@ -1,15 +1,14 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- -# Introduction +# User Guide diff --git a/docs/src/user/index.md b/docs/src/user/index.md index 341a0609f..45f1fb44e 100644 --- a/docs/src/user/index.md +++ b/docs/src/user/index.md @@ -1,15 +1,15 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "_author_ = 'irwan@kartoza.com'" -[//]: # "_date_ = '13/06/2023'" -[//]: # "_copyright_ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +context_id: moWP9iR7XuJSNtDCTAncQN +--- # For Users diff --git a/docs/src/user/manual/home.md b/docs/src/user/manual/home.md index b64a63856..3e4a00353 100644 --- a/docs/src/user/manual/home.md +++ b/docs/src/user/manual/home.md @@ -1,3 +1,16 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + # The Home Page ![Home Page](img/home.png) diff --git a/docs/src/user/manual/img/naming-convention.README b/docs/src/user/manual/img/naming-convention.README new file mode 100644 index 000000000..eadd4b330 --- /dev/null +++ b/docs/src/user/manual/img/naming-convention.README @@ -0,0 +1,7 @@ +# Image naming convention + +Images should be named according to reference doc, sub-section and order in document. +e.g. + +- The 1st image in instructions regarding zooming will be something like instr-zooming-1, the 2nd image will be instr-zooming-2, etc. +- The 1st image in quickstart regarding logging in will be qs-login-1, etc diff --git a/docs/src/user/manual/index.md b/docs/src/user/manual/index.md index ef90bcc2c..11b18cc28 100644 --- a/docs/src/user/manual/index.md +++ b/docs/src/user/manual/index.md @@ -1,19 +1,21 @@ -[//]: # "GeoSight is UNICEF's geospatial web-based business intelligence platform." -[//]: # -[//]: # "Contact : geosight-no-reply@unicef.org" -[//]: # -[//]: # ".. note:: This program is free software; you can redistribute it and/or modify" -[//]: # " it under the terms of the GNU Affero General Public License as published by" -[//]: # " the Free Software Foundation; either version 3 of the License, or" -[//]: # " (at your option) any later version." -[//]: # -[//]: # "__author__ = 'irwan@kartoza.com'" -[//]: # "__date__ = '13/06/2023'" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" -[//]: # "__copyright__ = ('Copyright 2023, Unicef')" +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- # User Manual -This section of the documentation describes every page in the application and what the various components of that page do. The manual is intended to function as a reference for the application. For narrative / workflow based tutorials, you may prefer to work through our [user guide](../guide/index.md). +This section of the documentation describes every page in the application and +what the various components of that page do. The manual is intended to function +as a reference for the application. For narrative / workflow based tutorials, +you may prefer to work through our [user guide](../guide/index.md). 1. [Home Page](home.md): This is the 'landing page' that you arrive on when you open the site. diff --git a/docs/src/user/quickstart/index.md b/docs/src/user/quickstart/index.md index 0a0af3535..e086d8867 100644 --- a/docs/src/user/quickstart/index.md +++ b/docs/src/user/quickstart/index.md @@ -1,3 +1,16 @@ +--- +title: GeoSight-OS Documentation Home +summary: GeoSight is UNICEF's geospatial web-based business intelligence platform. + - Tim Sutton + - Irwan Fathurrahman +date: 2023-08-03 +some_url: https://github.com/unicef-drp/GeoSight-OS +copyright: Copyright 2023, Unicef +contact: geosight-no-reply@unicef.org +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +#context_id: 1234 +--- + # Quickstart diff --git a/docs/hook.py b/docs/uuid_redirects_hook.py similarity index 100% rename from docs/hook.py rename to docs/uuid_redirects_hook.py