[DOC-125] Admin App pages (#125)

* initial check in after clean up of broken links * Fixing links, pages and menu items * updating links for index pages (readme.md) * updating broken links from build * Update Documents with the correct format and fix comments * Update for PR #125 and invalid links * PR #125 and code block commenting, with the title, instead of using a bold header, from the convertor * PR #125 - markdownlint formatting and correcting a spelling error * removing sub-TOC and deferring to right side bar * [!CAUTION] is now ⚠️ * PR #125 👍🏻 * PR #125 update link * PR #125 https://docs.ed-fi.org/getting-started/edfi-exchange/technology/ed-fi-odsapi-cloud-deployment-for-azure-suite-3/ * PR #125 - invalid link removed * Link and style fixes (#140) * Add additional link fixes. * Add additional update to links --------- Co-authored-by: Jesus Pardo <[email protected]> Co-authored-by: Stephen Fuqua <[email protected]> Co-authored-by: Robert Hunter Jr <[email protected]>
Ed-Fi-Alliance-OSS · Dec 19, 2024 · e3a0e22 · e3a0e22
1 parent 8607b56
commit e3a0e22
Show file tree

Hide file tree

Showing 42 changed files with 6,912 additions and 237 deletions.
diff --git a/...admin-api-1.x/installation-for-odsapi-5x-6x/admin-api-1x-docker-installation.md b/...admin-api-1.x/installation-for-odsapi-5x-6x/admin-api-1x-docker-installation.md
@@ -1,19 +1,16 @@
 # Admin API 1.x - Docker installation
 
-# Before You Install
+## Before You Install
 
 This section provides general information you should review before installing
 the Ed-Fi ODS / API Admin API for v1.4.0.
 
-## Compatibility & Supported ODS / API Versions
+### Compatibility & Supported ODS / API Versions
 
 This version of the Admin API has been tested and can be installed for use with
-the Ed-Fi ODS / API v3.4 - 6.1. See the [Ed-Fi Technology Version
-Index](https://edfi.atlassian.net/wiki/spaces/ETKB/pages/20875717/Ed-Fi+Technology+Version+Index) for more details.
+the Ed-Fi ODS / API v3.4 - 6.1. See the [Ed-Fi Technology Suite Supported Versions](/reference/roadmap/supported-versions) for more details.
 
-# Installation Instructions
-
-## General Prerequisites
+### General Prerequisites
 
 The following are required to install the Admin API:
 
@@ -31,7 +28,7 @@ The following are required to install the Admin API:
   pre-installed browser on Windows Server) may load but may not function when
   using Admin API.
 
-# Installation Instructions
+## Installation Instructions
 
 Admin API is not included with the ODS-Docker solution by default, but can be
 hosted as part of that ecosystem.
@@ -44,14 +41,14 @@ Then, apply the below changes to the environment to introduce the Admin API.
 Admin API does not support in-place upgrades from prior versions.  Please
 install a fresh copy of Admin API to upgrade from prior versions.
 
-## 1\. Include Admin API in the ODS Docker Setup
+### 1\. Include Admin API in the ODS Docker Setup
 
-### Docker Compose
+#### Docker Compose
 
 Add the following to your `docker-compose.yml`  file. This can be done either
 instead of or in addition to the `adminapp`  service.
 
-#### Admin API Application
+##### Admin API Application
 
 This service depends on the `pb-admin`  and subsequently `db-admin` services to
 run.
@@ -89,7 +86,7 @@ adminapi:
 # ... below are network and volume configs
 ```
 
-#### Admin API Database
+##### Admin API Database
 
 For the most part, the Admin API shares the same database schema as the Admin
 App. However, there are a few tables required for storing API client
@@ -127,15 +124,15 @@ db-admin:
 # ... below are other services
 ```
 
-### .env Settings
+#### .env Settings
 
 Add the following to your environment settings file to support Admin API. Note
 that when running both Admin App and Admin API, some of these settings may
 overlap. This is expected, and the same values can be used.
 
 **.env for Admin API**
 
-```docker
+```ini
 ADMIN_API_TAG=<version of image to run>
 ADMIN_API_DB_TAG=<version of image to run>
 API_MODE=<API Mode Eg. SharedInstance, YearSpecific, DistrictSpecific>
@@ -164,14 +161,14 @@ ADMIN_API_HEALTHCHECK_TEST="curl -f http://${ADMIN_API_VIRTUAL_NAME}/health"
 API_INTERNAL_URL = http://${ODS_VIRTUAL_NAME}
 ```
 
-### Nginx / Gateway Configuration
+#### Nginx / Gateway Configuration
 
 Update your nginx server configuration to include the Admin API in the reverse
 proxy.
 
 **default.conf.template**
 
-```json
+```none
 # upstream server config...
 
 server {
@@ -191,15 +188,15 @@ server {
 }
 ```
 
-## 2\. Relaunch the Docker Composition
+### 2\. Relaunch the Docker Composition
 
 After updating the files, restart the docker composition.
 
 ```shell
 docker compose -f ./compose/your-compose-file.yml --env-file ./.env up -d
 ```
 
-## 3\. Execute First-Time Configuration
+### 3\. Execute First-Time Configuration
 
 Continue on to [First-Time Configuration for Admin
 1.x](first-time-configuration-for-admin-api-1x.md).

diff --git a/...n-api-1.x/installation-for-odsapi-5x-6x/admin-api-1x-iis-installation-manual.md b/...n-api-1.x/installation-for-odsapi-5x-6x/admin-api-1x-iis-installation-manual.md
@@ -1,23 +1,22 @@
 # Admin API 1.x - IIS Installation (Manual)
 
-# Before You Install
+## Before You Install
 
 This section provides general information you should review before installing
 the Ed-Fi ODS / API Admin API for v1.4.0.
 
 ## Compatibility & Supported ODS / API Versions
 
 This version of the Admin API has been tested and can be installed for use with
-the Ed-Fi ODS / API v3.4 - 6.1.  See the [Ed-Fi Technology Version
-Index](https://edfi.atlassian.net/wiki/spaces/ETKB/pages/20875717/Ed-Fi+Technology+Version+Index) for
+the Ed-Fi ODS / API v3.4 - 6.1.  See the [Ed-Fi Technology Suite Supported Versions](/reference/roadmap/supported-versions) for
 more details.
 
 ## Installation Instructions
 
 ### Prerequisites
 
 A running instance of the ODS / API v3.4 - 6.1 platform must be configured and
-running before installing Admin API.  
+running before installing Admin API.
 
 Admin API only supports running one instance of the application at a time in an
 ODS / API ecosystem. Future versions may allow for scaling and load balancing.
@@ -139,6 +138,7 @@ Here is a snippet from a properly configured application settings file:
 ```
 
 #### **Step 5. Create Self-Signed Certificate in IIS Manager**
+
 :::info
  This step is only necessary if you do not have a certificate from an
  existing ODS / API and Admin App installation in IIS.
@@ -293,6 +293,7 @@ preference.
      CONSTRAINT PK_Tokens PRIMARY KEY (Id)
  );
  ```
+
 :::
 :::info note:
  SQL Server
@@ -369,6 +370,7 @@ preference.
      CONSTRAINT PK_Tokens PRIMARY KEY (Id)
  );
  ```
+
 :::
 
 #### **Step 10. Execute First-Time Configuration**
@@ -380,8 +382,8 @@ Continue on to [First-Time Configuration for Admin
  The following is a NuGet package containing the **Admin API v1.4.0
  source** **files** for manual deployment to IIS.
 
- * [EdFi.Suite3.ODS.AdminApi
+* [EdFi.Suite3.ODS.AdminApi
    1.4.0](https://dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_artifacts/feed/EdFi/NuGet/EdFi.Suite3.ODS.AdminApi/overview/1.4.0)
- * [Follow Binary Release for Admin App Database
+* [Follow Binary Release for Admin App Database
    v2.3](https://edfi.atlassian.net/wiki/display/ADMIN/Admin+App+for+Suite+3+v2.3)
 :::
diff --git a/...i-1.x/installation-for-odsapi-5x-6x/admin-api-1x-iis-installation-powershell.md b/...i-1.x/installation-for-odsapi-5x-6x/admin-api-1x-iis-installation-powershell.md
@@ -37,7 +37,7 @@ The following are required to install the Admin API with IIS:
 
 Each step is outlined in detail below for the PowerShell deployment. Ensure that
 you have permission to execute PowerShell scripts. For more information,
-see [http://go.microsoft.com/fwlink/?LinkID=135170](http://go.microsoft.com/fwlink/?LinkID=135170).
+see [about_Execution_Policies](http://go.microsoft.com/fwlink/?LinkID=135170).
 
 #### **Step 1. Rename and Unzip Admin API Source Files**
 
@@ -133,6 +133,7 @@ complete.
      AdminApiFeatures = $adminApiFeatures
  }
  ```
+
 :::
 
 :::info note:
@@ -166,6 +167,7 @@ complete.
      AdminApiFeatures = $adminApiFeatures
  }
  ```
+
 :::
 
 #### **Step 3. Open a PowerShell Prompt in Administrator Mode**
@@ -318,6 +320,7 @@ preference.
      CONSTRAINT PK_Tokens PRIMARY KEY (Id)
  );
  ```
+
 :::
 
 :::info note:
@@ -396,6 +399,7 @@ preference.
      CONSTRAINT PK_Tokens PRIMARY KEY (Id)
  );
  ```
+
 :::
 
 #### **Step 9. Execute First-Time Configuration**
@@ -407,8 +411,8 @@ Continue on to [First-Time Configuration for Admin
  The following is a Nuget package containing the **Admin API v1.4.0**
  binaries and installer scripts for deployment to IIS.
 
- * [EdFi.Suite3.ODS.AdminApi
+* [EdFi.Suite3.ODS.AdminApi
    1.4.0](https://dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance-OSS/_artifacts/feed/EdFi/NuGet/EdFi.Suite3.ODS.AdminApi/overview/1.4.0)
- * [Follow Binary Release for Admin App Database
+* [Follow Binary Release for Admin App Database
    v2.3](https://edfi.atlassian.net/wiki/display/ADMIN/Admin+App+for+Suite+3+v2.3)
 :::