Update README (#18)

Author: hyunsun

README.md

@@ -1,4 +1,13 @@
-# Welcome to the Cluster Connect Gateway
+# Cluster Connect Gateway
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Get Started](#get-started)
+- [Develop](#develop)
+- [Contribute](#contribute)
+- [Community and Support](#community-and-support)
+- [License](#license)
 
 ## Overview
 
@@ -13,70 +22,25 @@ Key features include:
 - **Cluster API integration**: Seamlessly work with Cluster API.
 - **Intel Open Edge Platform integration**: Seamlessly work with Intel® Open Edge Platform.
 
-## Get Started
-
-Install Cluster Connect Gateway operator.
-
-```
-helm install -n orch-system --create-namespace deployment/charts/cluster-connect-gateway-crd
-helm install -n orch-system --create-namespace deployment/charts/cluster-connect-gateway
-```
-
-Create a ClusterConnect for the edge cluster.
-
-```
-cat > example.yaml << "EOF"
-apiVersion: cluster.edge-orchestrator.intel.com/v1alpha1
-kind: ClusterConnect
-metadata:
-  name: example-cluster-connect
-spec:
-  serverCertRef:
-    apiVersion: v1
-    kind: Secret
-    name: example-cluster-ca
-    namespace: default
-  clientCertRef:
-    apiVersion: v1
-    kind: Secret
-    name: example-cluster-cca
-    namespace: default
-
-kubectl apply -f example.yaml
-```
-
-Get connect-agent pod manifest.
-
-```
-kubectl get clusterconnect example-cluster-connect \
-    -o go-template="{{ if .status.ready }}{{ .status.agentManifest }}{{ end }}" \
-    > connect-agent.yaml
-```
+Read more about Cluster Connect Gateway in the [Edge Cluster Orchestrator Developer Guide][cluster-orch-dev-guide-url] for internals and software architecture.
 
-Deploy connect-agent to the edge cluster.
-
-```
-kubectl apply -f connect-agent.yaml
-```
+## Get Started
 
-Another way to try out Cluster Connect Gateway is by using the Intel® Open Edge Platform. Refer to the [Documentation](https://literate-adventure-7vjeyem.pages.github.io/edge_orchestrator/user_guide_main/content/user_guide/get_started_guide/gsg_content.html) to get started with Intel® Open Edge Platform.
+The recommended way to try out the Cluster Connect Gateway is by using the Edge Orchestrator.
+Refer to the [Getting Started Guide](https://docs.openedgeplatform.intel.com/edge-manage-docs/main/user_guide/get_started_guide/index.html) to get started with the Edge Orchestrator.
 
 ## Develop
 
-If you are interested in contributing to the development of Cluster Connect Gateway, follow these steps to get started:
+If you are interested in contributing to the development of Cluster Connect Gateway, you will need an environment where you can use it to create and delete clusters.  
 
-```
-make run-e2e-and-keep
-```
-
-This command creates a KinD cluster, deploy cert-manager, Cluster API operator and providers, and build and deploy Cluster Connect Gateway from your local repository.
-
-After making changes, rebuild and deploy the updated code.
+The [cluster-tests](https://github.com/open-edge-platform/cluster-tests) repo provides a lightweight environment for integration testing of Cluster Connect Gateway as well as other Edge Orchestrator components related to cluster management. Clone that repo, change into the cluster-tests directory, and run:
 
 ```
-make redeploy
+make test
 ```
 
+This command creates a KinD cluster and deploys cert-manager, Cluster API operator, CAPI Provider for Intel, Cluster Manager, and Cluster Connect Gateway. It then creates and deletes a cluster inside a Kubernetes pod. Consult the cluster-tests [README](https://github.com/open-edge-platform/cluster-tests/blob/main/README.md) for details on how to test your code in this environment.
+
 ## Contribute
 
 We welcome contributions from the community! To contribute, please open a pull request to have your changes reviewed and merged into the main. To learn how to contribute to the project, see the [contributor's guide](https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/contributor_guide/index.html). We encourage you to add appropriate unit tests and e2e tests if your contribution introduces a new feature.
@@ -91,10 +55,13 @@ make license
 
 ## Community and Support
 
-To learn more about the project, its community, and governance, visit the Edge Orchestrator Community. 
-For support, start with Troubleshooting or contact us. 
+To learn more about the project, its community, and governance, visit the [Edge Orchestrator Community](https://docs.openedgeplatform.intel.com/edge-manage-docs/main/index.html). 
+For support, start with [Troubleshooting](https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/troubleshooting/index.html) or contact us. 
 
 ## License
 
 Cluster Connect Gateway is licensed under [Apache 2.0 License](LICENSES/Apache-2.0.txt)
 
+Last Updated Date: April 16, 2025
+
+[cluster-orch-dev-guide-url]: https://docs.openedgeplatform.intel.com/edge-manage-docs/main/developer_guide/cluster_orch/index.html