diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 8c9dd7e3..e4e82a38 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -34,6 +34,7 @@ theme: - navigation.instant - navigation.instant.preview - navigation.tabs + - navigation.footer # - navigation.tabs.sticky # - navigation.sections - navigation.expand @@ -112,22 +113,34 @@ nav: - Concepts: - index.md - getting_started.md - - Design: - - design_architecture.md - - design_infrastructure.md - - design_software.md + - Installation: + - install_prerequisites.md + - Features: + - feature_flags.md - Services: - services_overview.md - services_source.md - OSDU: - - services_core.md - - services_reference.md + - Core Services: + - services_core_partition.md + - services_core_entitlements.md + - services_core_legal.md + - services_core_schema.md + - services_core_storage.md + - services_core_indexer.md + - services_core_search.md + - services_core_file.md + - services_core_workflow.md + - Reference Services: + - services_reference_unit.md + - services_reference_crs.md + - services_reference_conversion.md - Experimental: - experimental_adminui.md - - Features: - - feature_flags.md - - Installation: - - install_prerequisites.md + - Design: + - design_architecture.md + - design_infrastructure.md + - design_software.md - Tutorials: - Deployment: - tutorial_cli.md diff --git a/docs/src/services_core_entitlements.md b/docs/src/services_core_entitlements.md new file mode 100644 index 00000000..33daf0dc --- /dev/null +++ b/docs/src/services_core_entitlements.md @@ -0,0 +1,41 @@ +# Entitlements + +The entitlement service can be run locally in editors with the following configuration. + +``` +Build and Run Configuration: SpringBoot +--------------------------------------- +Java SDK: java zulu-17 +Module: entitlements-v2-azure +Class: org.opengroup.osdu.entitlements.v2.azure.EntitlementsV2Application +VM Options: -javaagent://osdu-developer/src/applicationinsights-agent.jar +``` + +| Variable | Value | Description | +|--------------------------------------|------------------------------------------------|--------------------------------------------| +| `APPINSIGHTS_KEY` | `` | Application Insights key | +| `KEYVAULT_URI` | `"https://${KV_NAME}.vault.azure.net"` | Key Vault URI | +| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint | +| `AAD_CLIENT_ID` | `${AZURE_CLIENT_ID}` | Active Directory client ID | +| `SERVER_PORT` | `8080` | HTTP Server Port | +| `SPRING_APPLICATION_NAME` | `entitlements` | Spring application name | +| `LOGGING_LEVEL` | `INFO` | Logging level for the Entitlements service | +| `SERVICE_DOMAIN_NAME` | `dataservices.energy` | Service domain name | +| `ROOT_DATA_GROUP_QUOTA` | `5000` | Root data group quota | +| `REDIS_TTL_SECONDS` | `1` | Redis TTL in seconds | +| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on | +| `AZURE_ACTIVEDIRECTORY_SESSION_STATELESS` | `true` | Enable stateless session for AD | + + + +### Testing + +The entitlement service can be tested locally in IntelliJ with the following run configuration + +``` +Build and Run Configuration: JUnit +--------------------------------------- +Java SDK: Java zulu-17 +Module: entitlementsv2-test-azure +All in package: org.opengroup.osdu.entitlements +``` diff --git a/docs/src/services_core_file.md b/docs/src/services_core_file.md new file mode 100644 index 00000000..e8a4fe48 --- /dev/null +++ b/docs/src/services_core_file.md @@ -0,0 +1,26 @@ +# File + +The file service can be run locally in editors with the following configuration. + +``` +Build and Run Configuration: SpringBoot +--------------------------------------- +Java SDK: java zulu-17 +Module: file-azure +Class: org.opengroup.osdu.file.provider.azure.FileAzureApplication +VM Options: -javaagent://osdu-developer/src/applicationinsights-agent.jar +``` + +| Variable | Value | Description | +|--------------------------------------|------------------------------------------------|--------------------------------------------| +| `APPINSIGHTS_KEY` | `` | Application Insights key | +| `KEYVAULT_URI` | `` | Key Vault URI | +| `AZURE_HOST` | `` | Azure host IP | +| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint | +| `OSDU_ENTITLEMENTS_URL` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint | +| `AAD_CLIENT_ID` | `` | Active Directory client ID | +| `SPRING_APPLICATION_NAME` | `file` | Spring application name | +| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity | +| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on | +| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled | +| `LOG_PREFIX` | `file` | Log prefix | diff --git a/docs/src/services_core_indexer.md b/docs/src/services_core_indexer.md new file mode 100644 index 00000000..79f0d42e --- /dev/null +++ b/docs/src/services_core_indexer.md @@ -0,0 +1,30 @@ +# Indexer + +The indexer service can be run locally in editors with the following configuration. + +``` +Build and Run Configuration: SpringBoot +--------------------------------------- +Java SDK: java zulu-17 +Module: indexer-azure +Class: org.opengroup.osdu.indexer.azure.IndexerAzureApplication +VM Options: -javaagent://osdu-developer/src/applicationinsights-agent.jar +``` + +| Variable | Value | Description | +|--------------------------------------|------------------------------------------------|--------------------------------------------| +| `APPINSIGHTS_KEY` | `` | Application Insights key | +| `KEYVAULT_URI` | `` | Key Vault URI | +| `AZURE_HOST` | `` | Azure host IP | +| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint | +| `ENTITLEMENTS_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint | +| `SCHEMA_SERVICE_URL` | `http://${AZURE_HOST}/api/schema-service/v1` | Schema service endpoint | +| `STORAGE_SERVICE_URL` | `http://${AZURE_HOST}/api/storage/v2` | Storage service endpoint | +| `STORAGE_QUERY_RECORD_HOST` | `http://${AZURE_HOST}/api/storage/v2/query/records` | Storage service record query endpoint | +| `STORAGE_QUERY_RECORD_FOR_CONVERSION_HOST` | `http://${AZURE_HOST}/api/storage/v2/query/records:batch` | Storage service record batch query endpoint | +| `AAD_CLIENT_ID` | `` | Active Directory client ID | +| `SPRING_APPLICATION_NAME` | `indexer` | Spring application name | +| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity | +| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on | +| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled | +| `LOG_PREFIX` | `indexer` | Log prefix | diff --git a/docs/src/services_core_legal.md b/docs/src/services_core_legal.md new file mode 100644 index 00000000..4a0078af --- /dev/null +++ b/docs/src/services_core_legal.md @@ -0,0 +1,50 @@ +# Legal + +The legal service can be run locally in editors with the following configuration. + +``` +Build and Run Configuration: SpringBoot +--------------------------------------- +Java SDK: java zulu-17 +Module: legal-azure +Class: org.opengroup.osdu.legal.azure.LegalApplication +VM Options: -javaagent://osdu-developer/src/applicationinsights-agent.jar +``` + +| Variable | Value | Description | +|--------------------------------------|------------------------------------------------|--------------------------------------------| +| `KV_NAME` | `` | Key Vault name | +| `AZURE_TENANT_ID` | `` | Azure tenant ID | +| `AZURE_CLIENT_ID` | `` | Azure client ID | +| `AZURE_CLIENT_SECRET` | `` | Azure client secret | +| `APPINSIGHTS_KEY` | `` | Application Insights key | +| `KEYVAULT_URI` | `"https://${KV_NAME}.vault.azure.net"` | Key Vault URI | +| `AZURE_HOST` | `` | Azure host IP | +| `SPRING_APPLICATION_NAME` | `legal` | Spring application name | +| `AAD_CLIENT_ID` | `${AZURE_CLIENT_ID}` | Active Directory client ID | +| `REDIS_DATABASE` | `2` | Redis database number | +| `SERVICEBUS_TOPIC_NAME` | `legaltags` | Service Bus topic name | +| `COSMOSDB_DATABASE` | `osdu-db` | Cosmos DB database name | +| `ENTITLEMENTS_SERVICE_API_KEY` | `OBSOLETE` | Entitlements service API key | +| `LEGAL_SERVICE_REGION` | `us` | Legal service region | +| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint | +| `ENTITLEMENTS_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint | +| `AZURE_ISTIO_AUTH_ENABLED` | `true` | Turn Istio auth on | +| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity | +| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled | +| `AZURE_ACTIVEDIRECTORY_APP_ID_URI` | `api://${AZURE_CLIENT_ID}` | Active Directory app ID URI | +| `AZURE_ACTIVEDIRECTORY_SESSION_STATELESS` | `true` | Enable stateless session for AD | + + + +### Testing + +The legal service can be tested locally in IntelliJ with the following run configuration + +``` +Build and Run Configuration: JUnit +--------------------------------------- +Java SDK: Java zulu-17 +Module: legal-test-azure +All in package: org.opengroup.osdu.legal +``` \ No newline at end of file diff --git a/docs/src/services_core_partition.md b/docs/src/services_core_partition.md new file mode 100644 index 00000000..ccc6bd5a --- /dev/null +++ b/docs/src/services_core_partition.md @@ -0,0 +1,50 @@ +# Partition + +The partition service can be run locally in editors with the following configuration. + +``` +Build and Run Configuration: SpringBoot +--------------------------------------- +Java SDK: java zulu-17 +Module: partition-azure +Class: opengroup.osdu.partition.provider.azure.PartitionApplication +VM Options: -javaagent://osdu-developer/src/applicationinsights-agent.jar +``` + +The following environment variables are necessary to run the Partition Service. + + +| Variable | Value | Description | +|--------------------------------------|------------------------------------------------|--------------------------------------------| +| `APPINSIGHTS_KEY` | `` | Application Insights key | +| `KEYVAULT_URI` | `"https://.vault.azure.net"`| Key Vault URI | +| `AAD_CLIENT_ID` | `` | Active Directory client ID | +| `SERVER_PORT` | `8080` | HTTP Server Port | +| `SPRING_APPLICATION_NAME` | `partition` | Spring application name | +| `REDIS_DATABASE` | `1` | Redis database number | +| `PARTITION_SPRING_LOGGING_LEVEL` | `INFO` | Logging level for the Partition service | +| `AZURE_ISTIOAUTH_ENABLED` | `false` | Turn Istio auth off | +| `AZURE_ACTIVEDIRECTORY_APP_ID_URI` | `api://` | Active Directory app ID URI | +| `AZURE_ACTIVEDIRECTORY_SESSION_STATELESS` | `true` | Enable stateless session for AD | + + +### Testing + +The partition service can be tested locally in IntelliJ with the following run configuration + +``` +Build and Run Configuration: JUnit +--------------------------------------- +Java SDK: Java zulu-17 +Module: partition-test-azure +All in package: org.opengroup.osdu.partition +``` + +| Variable | Value | Description | +|-----------------------------------------|------------------------------------------------|--------------------------------------------| +| `ENVIRONMENT` | `` | local or cloud | +| `AZURE_AD_TENANT_ID` | `` | Azure tenant ID | +| `INTEGRATION_TESTER` | `` | Azure client ID | +| `AZURE_TESTER_SERVICEPRINCIPAL_SECRET` | `` | Azure client secret | +| `AZURE_AD_APP_RESOURCE_ID` | `` | Azure client ID | +| `PARTITION_BASE_URL` | `http://localhost:8080/` | Service URL | diff --git a/docs/src/services_core_schema.md b/docs/src/services_core_schema.md new file mode 100644 index 00000000..b06143b1 --- /dev/null +++ b/docs/src/services_core_schema.md @@ -0,0 +1,39 @@ +# Schema + +The schema service can be run locally in editors with the following configuration. + +``` +Build and Run Configuration: SpringBoot +--------------------------------------- +Java SDK: java zulu-17 +Module: os-schema-azure +Class: org.opengroup.osdu.schema.azure.SchemaApplication +VM Options: -javaagent://osdu-developer/src/applicationinsights-agent.jar +``` + +| Variable | Value | Description | +|--------------------------------------|------------------------------------------------|--------------------------------------------| +| `KV_NAME` | `` | Key Vault name | +| `STORAGE_ACCOUNT` | `` | Storage account name | +| `AZURE_TENANT_ID` | `` | Azure tenant ID | +| `AZURE_CLIENT_ID` | `` | Azure client ID | +| `AZURE_CLIENT_SECRET` | `` | Azure client secret | +| `APPINSIGHTS_KEY` | `` | Application Insights key | +| `KEYVAULT_URI` | `"https://${KV_NAME}.vault.azure.net"` | Key Vault URI | +| `AZURE_HOST` | `` | Azure host IP | +| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint | +| `ENTITLEMENTS_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint | +| `AAD_CLIENT_ID` | `${AZURE_CLIENT_ID}` | Active Directory client ID | +| `SPRING_APPLICATION_NAME` | `schema` | Spring application name | +| `LOG_PREFIX` | `schema` | Log prefix | +| `AZURE_STORAGE_ENABLE_HTTPS` | `true` | Enable HTTPS for Azure storage | +| `COSMOSDB_DATABASE` | `osdu-db` | Cosmos DB database name | +| `ENTITLEMENTS_SERVICE_API_KEY` | `OBSOLETE` | Entitlements service API key | +| `SERVER_PORT` | `8080` | Server port | +| `EVENT_GRID_ENABLED` | `false` | Enable Event Grid | +| `EVENT_GRID_TOPIC` | `schemachangedtopic` | Event Grid topic | +| `SERVICE_BUS_ENABLED` | `true` | Enable Service Bus | +| `SERVICEBUS_TOPIC_NAME` | `schemachangedtopic` | Service Bus topic name | +| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity | +| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on | +| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled | diff --git a/docs/src/services_core_search.md b/docs/src/services_core_search.md new file mode 100644 index 00000000..994324be --- /dev/null +++ b/docs/src/services_core_search.md @@ -0,0 +1,38 @@ +# Search + +The search service can be run locally in editors with the following configuration. + +``` +Build and Run Configuration: SpringBoot +--------------------------------------- +Java SDK: java zulu-17 +Module: search-azure +Class: org.opengroup.osdu.search.provider.azure.SearchApplication +VM Options: -javaagent://osdu-developer/src/applicationinsights-agent.jar +``` + +| Variable | Value | Description | +|--------------------------------------|------------------------------------------------|--------------------------------------------| +| `APPINSIGHTS_KEY` | `` | Application Insights key | +| `KEYVAULT_URI` | `` | Key Vault URI | +| `AZURE_HOST` | `` | Azure host IP | +| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint | +| `ENTITLEMENTS_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint | +| `POLICY_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/policy/api/policy/v1` | Policy service endpoint | +| `AAD_CLIENT_ID` | `` | Active Directory client ID | +| `SPRING_APPLICATION_NAME` | `search` | Spring application name | +| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity | +| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on | +| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled | +| `LOG_PREFIX` | `search` | Log prefix | +| `SEARCH_SERVICE_SPRING_LOGGING_LEVEL`| `DEBUG` | Logging level for the Search service | +| `ENTITLEMENTS_SERVICE_API_KEY` | `OBSOLETE` | API Key for Entitlements | +| `POLICY_SERVICE_ENABLED` | `false` | Enable Policy Service | +| `COSMOSDB_DATABASE` | `osdu-db` | Cosmos DB database name | +| `REDIS_DATABASE` | `5` | Redis database number | +| `ENVIRONMENT` | `evt` | Environment | +| `ELASTIC_CACHE_EXPIRATION` | `1` | Elastic cache expiration | +| `MAX_CACHE_VALUE_SIZE` | `60` | Maximum cache value size | +| `PARTITION_SERVICE_ENDPOINT` | `http://partition/api/partition/v1` | Partition service endpoint | +| `ENTITLEMENTS_SERVICE_ENDPOINT` | `http://entitlements/api/entitlements/v2` | Entitlements service endpoint | +| `POLICY_SERVICE_ENDPOINT` | `http://policy/api/policy/v1` | Policy service endpoint | \ No newline at end of file diff --git a/docs/src/services_core_storage.md b/docs/src/services_core_storage.md new file mode 100644 index 00000000..2bfa1b8d --- /dev/null +++ b/docs/src/services_core_storage.md @@ -0,0 +1,39 @@ +# Storage + +The storage service can be run locally in editors with the following configuration. + +``` +Build and Run Configuration: SpringBoot +--------------------------------------- +Java SDK: java zulu-17 +Module: storage-azure +Class: org.opengroup.osdu.storage.provider.azure.StorageApplication +VM Options: -javaagent://osdu-developer/src/applicationinsights-agent.jar +``` + +| Variable | Value | Description | +|--------------------------------------|------------------------------------------------|--------------------------------------------| +| `APPINSIGHTS_KEY` | `` | Application Insights key | +| `KEYVAULT_URI` | `` | Key Vault URI | +| `AZURE_HOST` | `` | Azure host IP | +| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1` | Partition service endpoint | +| `ENTITLEMENTS_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint | +| `LEGAL_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/legal/v1` | Legal service endpoint | +| `AAD_CLIENT_ID` | `` | Active Directory client ID | +| `SPRING_APPLICATION_NAME` | `storage` | Spring application name | +| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity | +| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on | +| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled | +| `LOG_PREFIX` | `storage` | Log prefix | +| `AZURE_STORAGE_ENABLE_HTTPS` | `true` | Enable HTTPS for Azure storage | +| `COSMOSDB_DATABASE` | `osdu-db` | Cosmos DB database name | +| `SERVER_PORT` | `8080` | Server port | +| `SERVICEBUS_TOPIC_NAME` | `recordstopic` | Service Bus topic name | +| `SERVICEBUS_V2_TOPIC_NAME` | `recordstopic-v2` | Service Bus topic name (version 2) | +| `REDIS_DATABASE` | `4` | Redis database number | +| `ENTITLEMENTS_SERVICE_API_KEY` | `OBSOLETE` | Entitlements service API key | +| `LEGAL_SERVICE_REGION` | `southcentralus` | Legal service region | +| `LEGAL_SERVICEBUS_TOPIC_NAME` | `legaltagschangedtopiceg` | Legal service bus topic name | +| `LEGAL_SERVICEBUS_TOPIC_SUBSCRIPTION`| `eg_sb_legaltagchangedsubscription` | Legal service bus topic subscription | +| `OPA_ENABLED` | `false` | Enable OPA | + diff --git a/docs/src/services_core_workflow.md b/docs/src/services_core_workflow.md new file mode 100644 index 00000000..0d026c15 --- /dev/null +++ b/docs/src/services_core_workflow.md @@ -0,0 +1,39 @@ +# Workflow + +The workflow service can be run locally in editors with the following configuration. + +``` +Build and Run Configuration: SpringBoot +--------------------------------------- +Java SDK: java zulu-17 +Module: file-azure +Class: org.opengroup.osdu.workflow.provider.azure.WorkflowAzureApplication +VM Options: -javaagent://osdu-developer/src/applicationinsights-agent.jar +``` + + +| Variable | Value | Description | +|--------------------------------------|------------------------------------------------|--------------------------------------------| +| `APPINSIGHTS_KEY` | `` | Application Insights key | +| `APPLICATIONINSIGHTS_CONNECTION_STRING` | `` | Application Insights Connection | +| `KEYVAULT_URI` | `` | Key Vault URI | +| `AZURE_HOST` | `` | Azure host IP | +| `PARTITION_SERVICE_ENDPOINT` | `http://${AZURE_HOST}/api/partition/v1/` | Partition service endpoint | +| `OSDU_ENTITLEMENTS_URL` | `http://${AZURE_HOST}/api/entitlements/v2` | Entitlements service endpoint | +| `OSDU_AIRFLOW_URL` | `https://${AZURE_HOST}/airflow` | Airflow URL | +| `AAD_CLIENT_ID` | `` | Active Directory client ID | +| `SPRING_APPLICATION_NAME` | `workflow` | Spring application name | +| `LOG_PREFIX` | `workflow` | Log prefix | +| `COSMOSDB_DATABASE` | `osdu-db` | Cosmos DB database name | +| `COSMOSDB_SYSTEM_DATABASE` | `osdu-system-db` | Cosmos DB system database name | +| `AIRFLOW_STORAGE_ACCOUNT_NAME` | `` | Airflow storage account name | +| `AZURE_PAAS_PODIDENTITY` | `false` | Azure PaaS pod identity | +| `AZURE_ISTIOAUTH_ENABLED` | `true` | Turn Istio auth on | +| `AZURE_PAAS_PODIDENTITY_ISENABLED` | `false` | Azure PaaS pod identity enabled | +| `OSDU_AIRFLOW_USERNAME` | `` | Airflow username | +| `OSDU_AIRFLOW_PASSWORD` | ` +- :material-source-branch: __Master Branch__ - Current code +- :material-tag-outline: __Release Branches__ - Milestone code + + + +!!! tip "Deploy Milestones" + Use Feature Flag _`SOFTWARE_VERSION`_ to deploy release branches. + + For available releases, see [OSDU Milestones](https://community.opengroup.org/osdu/platform/-/milestones). -Supported services of OSDU are primarily deployed from the current master branch. However, it is also possible to deploy release branches of OSDU as specified in the [OSDU Milestones](https://community.opengroup.org/osdu/platform/-/milestones) (e.g., release/0.25, release/0.26, release/0.27, etc.). ## Core Services @@ -37,7 +49,7 @@ Supported services of OSDU are primarily deployed from the current master branch OSDU offers various experimental capabilities that are either very new or community contributions. These services are not yet fully mature but are available for early adopters to test and provide feedback. This solution supports the concept of experimental software through opt-in feature flags, allowing users to selectively enable and test these new features. !!! note - Experimental software is often less stable with contains less documentation. + Experimental software is often less stable and contains less documentation. | **Name** | **Description** | |-------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| diff --git a/docs/src/services_reference.md b/docs/src/services_reference.md deleted file mode 100644 index d40b288b..00000000 --- a/docs/src/services_reference.md +++ /dev/null @@ -1,3 +0,0 @@ -# Reference Services - -Coming Soon \ No newline at end of file diff --git a/docs/src/services_reference_conversion.md b/docs/src/services_reference_conversion.md new file mode 100644 index 00000000..c8256a77 --- /dev/null +++ b/docs/src/services_reference_conversion.md @@ -0,0 +1,3 @@ +# CRS Conversion + +Coming Soon \ No newline at end of file diff --git a/docs/src/services_reference_crs.md b/docs/src/services_reference_crs.md new file mode 100644 index 00000000..72b409ce --- /dev/null +++ b/docs/src/services_reference_crs.md @@ -0,0 +1,3 @@ +# CRS Catalog + +Coming Soon \ No newline at end of file diff --git a/docs/src/services_reference_unit.md b/docs/src/services_reference_unit.md new file mode 100644 index 00000000..609a4240 --- /dev/null +++ b/docs/src/services_reference_unit.md @@ -0,0 +1,3 @@ +# Unit + +Coming Soon \ No newline at end of file diff --git a/docs/src/services_source.md b/docs/src/services_source.md index c37e5c68..99e026a8 100644 --- a/docs/src/services_source.md +++ b/docs/src/services_source.md @@ -1,23 +1,18 @@ -# Source Code +# OSDU Source Code -Welcome to working with OSDU Source Code! The `src` directory is structured to help you easily clone down the OSDU services and related repositories using the `gita` command. +This section provides comprehensive guidance for working with the community code and integrates automatically with an OSDU™ Personal Instance. The preconfigured `src` directory structure optimizes the organization of repositories to enable efficiency. A personal instance includes generated environment variables to streamline the development process. +!!! tip + Environment variables can be referenced in IntelliJ with the [EnvFile](https://plugins.jetbrains.com/plugin/7861-envfile) plugin. !!! warning - Avoid using containers, instead use a local machine when working with OSDU source code. + Avoid using containers, always use a local machine when working with OSDU™ source code. ## Overview The directory is organized into the following structure: -``` -src/ -├── lib -├── core -└── reference -``` -
diff --git a/docs/src/stylesheets/extra.css b/docs/src/stylesheets/extra.css index a1284c77..ec40eae4 100644 --- a/docs/src/stylesheets/extra.css +++ b/docs/src/stylesheets/extra.css @@ -3,22 +3,26 @@ --md-footer-fg-color: hsla(0, 0%, 100%, 1); --md-footer-fg-color--light: hsla(0, 0%, 100%, 0.7); --md-footer-fg-color--lighter: hsla(0, 0%, 100%, 0.3); - --md-footer-bg-color: #01393b;; - --md-footer-bg-color--dark: #01393b; + --md-footer-bg-color: #01696e; --md-typeset-a-color: #0199a1; } [data-md-color-scheme="default"] { --md-primary-fg-color: #01696e; --md-accent-fg-color: #02c9d3; + --md-footer-bg-color: #01696e; } [data-md-color-scheme="slate"] { --md-primary-fg-color: #01393b; --md-accent-fg-color: #02c9d3; + --md-footer-bg-color: #01393b; } li.md-nav__item--section > label.md-nav__link > span.md-ellipsis { color: #01696e; } +.md-footer-meta { + background-color: var(--md-footer-bg-color); +} \ No newline at end of file