docs: lacking documentation trgs

.tractusx

@@ -19,3 +19,6 @@
 
 product: "Tractus-X Knowledge Agents AAS Bridges (KA-AAS)"
 leadingRepository: "https://github.com/eclipse-tractusx/knowledge-agents"
+openApiSpecs: 
+  - "https://github.com/eclipse-tractusx/knowledge-agents/blob/main/docs/api/openAPI.yaml"
+  - "https://github.com/admin-shell-io/aas-specs-api/blob/main/Entire-API-Collection/V3.0.yaml"

README.md

@@ -27,8 +27,12 @@
 ![GitHub all releases](https://img.shields.io/github/downloads/eclipse-tractusx/knowledge-agents-aas-bridge/total)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=eclipse-tractusx_knowledge-agents-aas-bridge&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=eclipse-tractusx_knowledge-agents-aas-bridge)
 
-Tractus-X Knowledge Agents AAS Bridges (KA-AAS) is a product of the [Catena-X Knowledge Agents Kit (about to move to: Tractus-X Knowledge Agents Kit)](https://bit.ly/tractusx-agents). It implements bridging components between the [Catena-X Association's](http://catena-x.net) CX-0084 (Federated Queries in Dataspaces) and [Industrial Digitial Twin Association's](https://industrialdigitaltwin.org/) AAS Part 1 & 2 (Asset Administration Sheel) standards. 
+Tractus-X Knowledge Agents AAS Bridges (KA-AAS) is a product of the [Tractus-X Knowledge Agents Kit](https://eclipse-tractusx.github.io/docs-kits/kits/knowledge-agents/adoption-view/intro). It implements bridging components between the [Catena-X Association's](http://catena-x.net) CX-0084 (Federated Queries in Dataspaces) and [Industrial Digitial Twin Association's](https://industrialdigitaltwin.org/) AAS Part 1 & 2 (Asset Administration Sheel) standards. 
 
+* See the [User Documentation](docs/README.md)
+* See the [Architecture](docs/architecture/Arc42.md)
+* See the [Knowledge Agents OpenAPI](https://github.com/eclipse-tractusx/knowledge-agents/blob/main/docs/api/openAPI.yaml) and the [Asset Administration Shell OpenAPI](https://github.com/admin-shell-io/aas-specs-api/blob/main/Entire-API-Collection/V3.0.yaml)
+* See the [Administration Guide](docs/admin/README.md)
 * See the [Authors](AUTHORS.md)
 * See the [Changelog](CHANGELOG.md)
 * See the [Code of Conduct](CODE_OF_CONDUCT.md)
@@ -78,16 +82,6 @@ To update the [DEPENDENCIES](./DEPENDENCIES) declarations
 ./mvnw org.eclipse.dash:license-tool-plugin:license-check 
 ```
 
-### Deployment
-
-Deployment can be done
-* via [JAR libraries](https://github.com/orgs/eclipse-tractusx/packages?repo_name=knowledge-agents-aas-bridge&ecosystem=maven) copied into your Java runtime
-* via [Docker images](https://hub.docker.com/r/tractusx) 
-* via [Helm Charts (Stable Versions)](https://eclipse-tractusx.github.io/charts/stable) or [Helm Charts (Dev Versions)](https://eclipse-tractusx.github.io/charts/stable)
-
-See the individual bridge documentations for more detailed deployment information
-* [Knowledge Agents Sparql-To-AAS Bridge (KA-AAS-SPARQL)](sparql-aas/README.md)
-
 #### Setup using Helm/Kind
 
 In order to run KA-RI applications via helm on your local machine, please make sure the following
@@ -115,7 +109,6 @@ kind load docker-image docker.io/tractusx/aas-bridge:1.14.24-SNAPSHOT --name ka
 ct install --charts charts/aas-bridge
 ```
 
-
 ### Notice for Docker Images
 
 * [Notice for Knowledge Agents Sparql-To-AAS Bridge (KA-AAS-SPARQL)](sparql-aas/README.md#notice-for-docker-images)

docs/README.md

@@ -0,0 +1,52 @@
+<!--
+ * Copyright (c) 2022,2024 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+
+-->
+
+# Tractus-X Knowledge Agents AAS Bridges (KA-AAS) Documentation
+
+In the [Knowledge Agent Architecture](architecture/Arc42.md), an Agent is any component which speaks and/or enacts a Semantic Web protocol, such as SPARQL.
+
+According to AAS Part 1 & 2, an "Asset Administration Shell" (Server, Registry) is a component that allows to represent and query a source using a predefined REST Api.
+
+Both Knowledge Agents as well as AAS components are expected to be compatible to the [Tractus-X EDC](https://github.com/eclipse-tractusx/tractusx-edc) connector.
+
+A Bridge is a component which adapts the interface of one technology/standard (such as AAS) into the interface of the other (Knowledge Agent/Semantic Web).
+
+See the [Knowledge Agents OpenAPI](https://github.com/eclipse-tractusx/knowledge-agents/blob/main/docs/api/openAPI.yaml) and the [Asset Administration Shell OpenAPI](https://github.com/admin-shell-io/aas-specs-api/blob/main/Entire-API-Collection/V3.0.yaml) for reference.
+
+## How it works
+
+### KA AAS Bridge
+
+![KA_AAS_Bridge](aas_bridge.drawio.png)
+
+Currently we provide an AAS server/AAS registry interface that is backed by a one or several agents where the agents themselves could be Binding Agents or even Matchmaking Agents - see the [Knowledge Agent Architecture](architecture/Arc42.md) 
+
+## Deployment
+
+See the [Administration Guide](admin/README.md)
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2022,2023 T-Systems International GmbH
+- SPDX-FileCopyrightText: 2022,2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/knowledge-agents

docs/admin/README.md

@@ -0,0 +1,77 @@
+<!--
+ * Copyright (c) 2022,2024 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+
+-->
+# Tractus-X Knowledge Agents AAS Bridges (KA-AAS) Administration Guide
+
+## Deployment
+
+Deployment can be done
+* via [JAR libraries](https://github.com/orgs/eclipse-tractusx/packages?repo_name=knowledge-agents-aas-bridge&ecosystem=maven) copied into your Java runtime
+* via [Docker images](https://hub.docker.com/r/tractusx) 
+* via [Helm Charts (Stable Versions)](https://eclipse-tractusx.github.io/charts/stable) or [Helm Charts (Dev Versions)](https://eclipse-tractusx.github.io/charts/stable)
+
+
+## Helm Chart for Sparql-To-AAS Bridge
+
+A helm chart for deploying the bridge can be found under [this folder](../../charts/aas-bridge).
+
+It can be added to your umbrella chart.yaml by the following snippet
+
+```console
+dependencies:
+  - name: aas-bridge
+    repository: https://eclipse-tractusx.github.io/charts/dev
+    version: 1.14.24-SNAPSHOT
+    alias: my-aas-bridge
+```
+
+and then installed using
+
+```console
+helm dependency update
+```
+
+In your values.yml, you configure your specific instance of the conforming agent like this
+
+```console
+aas-bridge:
+  aas:
+    persistence:
+      # -- The sparql server
+      sparql: http://oem-provider-agent:8082/sparql
+    endpoints:
+      default:
+        path: "/"
+  ingresses:
+  - enabled: true
+    hostname: *oemAasHost
+    annotations:
+      nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
+#      nginx.ingress.kubernetes.io/ssl-passthrough: "true"
+#      nginx.ingress.kubernetes.io/ssl-redirect: "true"
+    endpoints:
+      - default
+    tls:
+      enabled: true
+    certManager:
+      clusterIssuer: *clusterIssuer
+```
+
+
+