Commit a19fe3fd authored by Daniel Scholl's avatar Daniel Scholl
Browse files

Merge branch 'documentation_Work' into 'master'

Documentation work

See merge request !44
parents aa3eb885 db82e20c
......@@ -244,15 +244,15 @@ __Manual Installation__
1. Install the Infrastructure following directions [here](./infra/templates/osdu-r3-mvp).
2. Setup DNS to point to the deployed infrastructure following directions [here](./docs/dns-setup.md).
1. Setup DNS to point to the deployed infrastructure following directions [here](./docs/dns-setup.md).
3. Upload the Integration Test Data following directions [here](./tools/test_data/README.md).
1. Upload the Integration Test Data following directions [here](./tools/test_data/README.md).
4. Deploy the application helm charts following the directions [here](./charts/README.md).
1. Deploy the application helm charts following the directions [here](./charts/README.md).
5. Register the Data Partition API using the API request located [here](../tools/rest/partition.http).
1. Register your partition with the Data Partition API by following the instructions [here](./tools/rest/README.md) to configure your IDE to make authenticated requests to your OSDU instance and send the API request located [here](./tools/rest/partition.http) (createPartition).
6. Setup Environment Variables for IDE Development and Integration Testing.
1. Setup Environment Variables for IDE Development and Integration Testing following the directions [here](./tools/variables/README.md).
__Automated Pipeline Installation__
......@@ -261,20 +261,17 @@ __Automated Pipeline Installation__
1. Setup Code Mirroring following directions [here](./docs/code-mirroring.md).
2. Setup Infrastructure Automation following directions [here](./docs/infra-automation.md).
1. Setup Infrastructure Automation following directions [here](./docs/infra-automation.md).
2. Setup DNS to point to the deployed infrastructure following directions [here](./docs/dns-setup.md).
1. Setup DNS to point to the deployed infrastructure following directions [here](./docs/dns-setup.md).
4. Upload the Integration Test Data following directions [here](./tools/test_data).
5. Setup Service Automation following directions [here](./docs/service-automation.md).
6. Register the Data Partition API using the API request located [here](../tools/rest/partition.http).
7. Enable Integration Tests for the pipelines.
1. Upload the Integration Test Data following directions [here](./tools/test_data).
1. Setup Service Automation following directions [here](./docs/service-automation.md).
1. Register your partition with the Data Partition API by following the instructions [here](./tools/rest/README.md) to configure your IDE to make authenticated requests to your OSDU instance and send the API request located [here](./tools/rest/partition.http) (createPartition).
1. Enable Integration Tests for the pipelines.
## Developer Activities
......
......@@ -29,3 +29,8 @@ do
done
```
For each service, there are four files generated by each of these scripts in the `./$UNIQUE` directory:
* `./${UNIQUE}/${SERVICE}.envrc` file that contains all environment variale definitions required for the service to run as well as those required to run integration tests on the service.
* `${UNIQUE}/${SERVICE}_local.yaml` file that contains the environment variable definitions required to run the service locally.
* `${UNIQUE}/${SERVICE}_local_test.yaml` file that contains the environment variable definitions required to test the service while it is running locally.
* `${UNIQUE}/${SERVICE}_test.yaml` file that contains the environment variable definitions required to test the service that is running in your AKS cluster.
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment