Merge pull request #388 from hydroserver2/1.9-docs

1.9 docs

Author: kjlippold

apps/docs/docs/.vitepress/config.ts

@@ -105,21 +105,21 @@ export default defineConfig({
         text: "How-to",
         collapsed: true,
         items: [
-          {
-            text: "Data Management App",
-            collapsed: true,
-            link: "/how-to/data-management-app/customize.md",
-            items: [
-              {
-                text: "Customize the Data Management App",
-                link: "/how-to/data-management-app/customize.md",
-              },
-              // {
-              //   text: "Archive Data to HydroShare",
-              //   link: "/how-to/data-management-app/hydroshare-archive.md",
-              // },
-            ],
-          },
+          // {
+          //   text: "Data Management App",
+          //   collapsed: true,
+          //   link: "/how-to/data-management-app/customize.md",
+          //   items: [
+          //     {
+          //       text: "Customize the Data Management App",
+          //       link: "/how-to/data-management-app/customize.md",
+          //     },
+          //     // {
+          //     //   text: "Archive Data to HydroShare",
+          //     //   link: "/how-to/data-management-app/hydroshare-archive.md",
+          //     // },
+          //   ],
+          // },
           {
             text: "Deployment",
             collapsed: true,
@@ -136,7 +136,7 @@ export default defineConfig({
             ],
           },
           {
-            text: "Hydroserverpy",
+            text: "Python Client",
             collapsed: true,
             link: "/how-to/hydroserverpy/hydroserverpy-examples",
             items: [

apps/docs/docs/how-to/deployment/examples/docker-compose/docker-compose.yaml

@@ -2,7 +2,7 @@ version: "3.9"
 
 services:
   hydroserver:
-    image: ghcr.io/hydroserver2/hydroserver-api-services:latest
+    image: ghcr.io/hydroserver2/hydroserver:latest
     command: python manage.py run_demo
     restart: unless-stopped
     environment:
@@ -39,4 +39,4 @@ services:
 volumes:
   db:
   static:
-  media:
+  media:

apps/docs/docs/how-to/deployment/examples/terraform-aws/main.tf

@@ -53,7 +53,7 @@ resource "null_resource" "ghcr_to_ecr" {
 
       REGION="${var.region}"
       REPO="${aws_ecr_repository.hydroserver.repository_url}"
-      GHCR_IMAGE="ghcr.io/hydroserver2/hydroserver-api-services:latest"
+      GHCR_IMAGE="ghcr.io/hydroserver2/hydroserver:latest"
 
       # ECR Authentication
       aws ecr get-login-password --region $REGION | docker login --username AWS --password-stdin $(echo $REPO | cut -d/ -f1)

apps/docs/docs/how-to/deployment/examples/terraform-gcp/main.tf

@@ -47,8 +47,8 @@ resource "null_resource" "ghcr_to_artifact_registry" {
       set -euo pipefail
 
       REGION="${var.region}"
-      REPO="${var.region}-docker.pkg.dev/${var.project_id}/hydroserver-demo/hydroserver-api-services"
-      GHCR_IMAGE="ghcr.io/hydroserver2/hydroserver-api-services:latest"
+      REPO="${var.region}-docker.pkg.dev/${var.project_id}/hydroserver-demo/hydroserver"
+      GHCR_IMAGE="ghcr.io/hydroserver2/hydroserver:latest"
 
       # GCP Authentication
       gcloud auth configure-docker $REGION-docker.pkg.dev --quiet
@@ -112,7 +112,7 @@ resource "google_cloud_run_v2_service" "hydroserver" {
 
   template {
     containers {
-      image   = "${var.region}-docker.pkg.dev/${var.project_id}/hydroserver-demo/hydroserver-api-services:latest"
+      image   = "${var.region}-docker.pkg.dev/${var.project_id}/hydroserver-demo/hydroserver:latest"
       command = ["python", "manage.py", "run_demo"]
 
       resources {

apps/docs/docs/how-to/deployment/production-deployment-overview.md

@@ -8,7 +8,7 @@ deployment platform.
 
 ## HydroServer Required Infrastructure 
 
-Each HydroServer release includes a [**container image**](https://github.com/hydroserver2/hydroserver-api-services/pkgs/container/hydroserver-api-services) 
+Each HydroServer release includes a [**container image**](https://github.com/hydroserver2/hydroserver/pkgs/container/hydroserver) 
 that packages the core HydroServer website, APIs, and supporting services. This image follows the OCI (Open Container 
 Initiative) standard and can be deployed on any platform that supports [**Docker**](https://www.docker.com/) or other 
 OCI-compatible runtimes, including commercial cloud providers or local environments. The image comes pre-configured with 

apps/docs/docs/how-to/development/development-setup.md

@@ -23,7 +23,7 @@ Before starting, make sure you have the following software installed on your mac
    git clone https://github.com/hydroserver2/hydroserver.git
    cd hydroserver/deploy/dev
    ```
-2. Create environment variables for static and media file paths. The default locations of these folders should be `/static` and `/media` within the `hydroserver-api-services` project folder.
+2. Create environment variables for static and media file paths. The default locations of these folders should be `/static` and `/media` within the `hydroserver` project folder.
    Mac/Linux:
    ```bash
    export HS_MEDIAFILES="/path/to/media"
@@ -39,51 +39,51 @@ Before starting, make sure you have the following software installed on your mac
    docker compose --file "docker-compose.yaml" up
    ```
 
-## HydroServer API Services
-
-### Installation
+## Installation
 
 1. Clone the repository:
    ```bash
-   git clone https://github.com/hydroserver2/hydroserver-api-services.git
-   cd hydroserver-api-services
+   git clone https://github.com/hydroserver2/hydroserver.git
+   cd hydroserver
    ```
-2. Install the dependencies:
+
+## HydroServer Backend Setup
+
+### Installation
+
+1. Navigate to `django` and install the dependencies:
    ```bash
+   cd django
    pip install -r requirements.txt
    ```
-3. Create a .env file in the root of the repository and update variables as needed. For getting started, the default settings should be sufficient.
-4. Perform database migrations and collect static files:
+2. Create a .env file and update variables as needed. For getting started, the default settings should be sufficient.
+3. Perform database migrations and collect static files:
    ```bash
    python manage.py migrate
    python manage.py collectstatic
    ```
-5. Create an admin user and load test data.
+4. Create an admin user and load test data.
    ```bash
    python manage.py createsuperuser
    python manage.py load_iam_test_data
    python manage.py load_sta_test_data
    ```
-6. Start the development web server:
+5. Start the Django development web server:
    ```bash
    python manage.py runserver
    ```
 
-## HydroServer Data Management App
+## HydroServer Frontend
 
 ### Installation
 
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/hydroserver2/hydroserver-data-management-app.git
-   ```
-2. Navigate to the project directory and install the required packages:
+1. Navigate to `apps/data-management` and install the required packages:
    ```bash
    cd hydroserver-data-management-app
    npm install
    ```
-3. Create a .env file in the root of the repository and update variables as needed. For getting started, the default settings should be sufficient.
-4. Build the static files and run the application in production mode:
+2. Create a .env file and update variables as needed. For getting started, the default settings should be sufficient.
+3. Build the static files and run the application in production mode:
    ```bash
    npm run build
    npm run preview