docs(opi): moved the docs to a folder and updated file references

Signed-off-by: sakethanne <asvn.saketh@gmail.com>
opiproject · Nov 6, 2024 · af74dbc · af74dbc
1 parent 5e03495
commit af74dbc
Show file tree

Hide file tree

Showing 13 changed files with 19 additions and 19 deletions.
diff --git a/bom.md → Documentation/bom.md b/bom.md → Documentation/bom.md
diff --git a/cables.md → Documentation/cables.md b/cables.md → Documentation/cables.md
diff --git a/hosting_files_on_webserver.md → Documentation/hosting_files_on_webserver.md b/hosting_files_on_webserver.md → Documentation/hosting_files_on_webserver.md
diff --git a/idrac_os_installation_steps_network.md → ...on/idrac_os_installation_steps_network.md b/idrac_os_installation_steps_network.md → ...on/idrac_os_installation_steps_network.md
diff --git a/idrac_os_installation_steps_virtual_media.md → ...ac_os_installation_steps_virtual_media.md b/idrac_os_installation_steps_virtual_media.md → ...ac_os_installation_steps_virtual_media.md
diff --git a/ips.md → Documentation/ips.md b/ips.md → Documentation/ips.md
diff --git a/otel.md → Documentation/otel.md b/otel.md → Documentation/otel.md
diff --git a/physical-testbed.md → Documentation/physical-testbed.md b/physical-testbed.md → Documentation/physical-testbed.md
diff --git a/running-the-tests.md → Documentation/running-the-tests.md b/running-the-tests.md → Documentation/running-the-tests.md
diff --git a/server-setup.md → Documentation/server-setup.md b/server-setup.md → Documentation/server-setup.md
@@ -10,9 +10,9 @@ ansible-playbook -i inventory site.yml
 
 ## Manual
 
-For more details on iDRAC OS Installation using Virtual media see [here](idrac_os_installation_steps_virtual_media.md)
+For more details on iDRAC OS Installation using Virtual media see [here](idrac_os_installation_steps_virtual_media.md).
 
-For more details on iDRAC OS Installation using Remote File Share see [here](idrac_os_installation_steps_network.md)
+For more details on iDRAC OS Installation using Remote File Share see [here](idrac_os_installation_steps_network.md).
 
 * Install Ubuntu[^1] 22.04 x64 on the server. ([ubuntu-22.04.1-live-server-amd64.iso](https://releases.ubuntu.com/22.04/))
   * select all default options (unless otherwise noted bellow)

diff --git a/README.md b/README.md
@@ -35,12 +35,12 @@ We manage all passwords in <https://opi-team.1password.com>
 
 - [Goals and Requirments](goals-and-requirements.md)
 - Setup
-  - [Cables/Fibers/transceivers](./cables.md)
-  - [LAB IPs allocation](./ips.md) and [Inventory](./ansible/inventory)
-  - [Open Telemetry Observability](./otel.md)
-  - [Server Software Setup](server-setup.md)
-  - [Bill of Materials](bom.md)
-  - [Physical Testbed Setup](physical-testbed.md)
+  - [Cables/Fibers/transceivers](./Documentation/cables.md)
+  - [LAB IPs allocation](./Documentation/ips.md) and [Inventory](./ansible/inventory)
+  - [Open Telemetry Observability](./Documentation/otel.md)
+  - [Server Software Setup](./Documentation/server-setup.md)
+  - [Bill of Materials](./Documentation/bom.md)
+  - [Physical Testbed Setup](./Documentation/physical-testbed.md)
     - [ToR - Arista DCS-7280TR-48C6-R](./hardware/ToR/README.md)
     - [TS - Serial Consoles - Avocent ACS8000](./hardware/TS/README.md)
     - [KVM - KVM Switch - Avocent MPU8032DAC](./hardware/KVM/README.md)
@@ -52,7 +52,7 @@ We manage all passwords in <https://opi-team.1password.com>
     - [DH4 - DPU Host 4 - Dell R760](./hardware/dh4/README.md)
     - [A100G - 100G Switch - Arista DCS-7280CR](./hardware/A100G/README.md)
     - [TGEN1 - Traffic Generator 1 - Supermicro](./hardware/tgen1/README.md)
-- [Running the Test Cases](running-the-tests.md)
+- [Running the Test Cases](./Documentation/running-the-tests.md)
 
 ## Rack diagram
 

diff --git a/hardware/README.md b/hardware/README.md
@@ -1,11 +1,11 @@
 # OPI Lab
 
-- [Cables](../cables.md)
-- [LAB IPs allocation](../ips.md) and [Inventory](../ansible/inventory)
-- [Server Software Setup](../server-setup.md)
-- [Bill of Materials](../bom.md)
-- [Physical Testbed Setup](../physical-testbed.md)
-- [Running the Test Cases](../running-the-tests.md)
+- [Cables](../Documentation/cables.md)
+- [LAB IPs allocation](../Documentation/ips.md) and [Inventory](../ansible/inventory)
+- [Server Software Setup](../Documentation/server-setup.md)
+- [Bill of Materials](../Documentation/bom.md)
+- [Physical Testbed Setup](../Documentation/physical-testbed.md)
+- [Running the Test Cases](../Documentation/running-the-tests.md)
 - [Goals and Requirments](../goals-and-requirements.md)
 
 ## OPI Rack

diff --git a/hardware/mgmt/README.md b/hardware/mgmt/README.md
@@ -31,19 +31,19 @@ Follow GitHub [instructions](https://github.com/opiproject/opi-poc/settings/acti
 
 ## Ansible
 
-- Run `docker compose up -d semaphore` or `docker-compose up -d semaphore` from [here](../../otel).
+- Run `docker compose up -d semaphore` or `docker-compose up -d semaphore` from [here](../../Documentation/otel).
 - This will start [Ansible Semaphore](https://docs.semui.co).
 - Access it via <http://172.22.0.1:4000/>
 
 ## Portainer
 
-- Run `docker compose up -d portainer` or `docker-compose up -d portainer` from [here](../../otel).
+- Run `docker compose up -d portainer` or `docker-compose up -d portainer` from [here](../../Documentation/otel).
 - This will start [Portainer Community Edition](https://www.portainer.io/).
 - Access it via <http://172.22.0.1:9000/>
 
 ## Monitoring & Telemetry
 
-Run `docker compose up -d` or `docker-compose up -d` from [here](../../otel)
+Run `docker compose up -d` or `docker-compose up -d` from [here](../../Documentation/otel)
 
 1. [OTEL Gateway Collector](https://opentelemetry.io/docs/collector/deployment/gateway/) to aggregate telemetry from all DPUs and IPUs.
 2. [Prometheus](https://prometheus.io/) Monitoring system & time series database
@@ -57,7 +57,7 @@ Acccess it via:
 
 ## Paswordless
 
-for all servers, dpu and ipus from [here](../../ips.md) run:
+for all servers, dpu and ipus from [here](../../Documentation/ips.md) run:
 
 ```bash
  ssh-copy-id root@172.22.X.X