Merge pull request #3 from slack/update-readme

doc: update README

README.md

@@ -1,53 +1,49 @@
 ---
 page_type: sample
 languages:
-- csharp
+- yaml
 products:
-- dotnet
-description: "Add 150 character max description"
+- azure-arc
+description: "Example repository for Azure Arc enabled Kubernetes"
 urlFragment: "update-this-to-unique-url-stub"
 ---
 
-# Official Microsoft Sample
+# Official sample for Azure Arc enabled Kubernetes
 
-<!-- 
-Guidelines on README format: https://review.docs.microsoft.com/help/onboard/admin/samples/concepts/readme-template?branch=master
-
-Guidance on onboarding samples to docs.microsoft.com/samples: https://review.docs.microsoft.com/help/onboard/admin/samples/process/onboarding?branch=master
-
-Taxonomies for products and languages: https://review.docs.microsoft.com/new-hope/information-architecture/metadata/taxonomies?branch=master
--->
-
-Give a short description for your sample here. What does it do and why is it important?
+This repository is an example of a basic GitOps repository that can be used with Azure Arc enabled Kubernetes.
 
 ## Contents
 
 Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets.
 
 | File/folder       | Description                                |
 |-------------------|--------------------------------------------|
-| `src`             | Sample source code.                        |
-| `.gitignore`      | Define what to ignore at commit time.      |
-| `CHANGELOG.md`    | List of changes to the sample.             |
-| `CONTRIBUTING.md` | Guidelines for contributing to the sample. |
-| `README.md`       | This README file.                          |
-| `LICENSE`         | The license for the sample.                |
+| `README.md`       | This README file. |
+| `cluster-apps`    | Contains an example application that should be deployed to every cluster. |
+| `namespaces`    | Contains three namespace resources to provision on an attached cluster. |
+| `policy`    | Example policy definition for applying GitOps configurations to a cluster. |
+| `team-a`    | Contains a ConfigMap resource written into `team-a` namespace, communicates configuration data for the application team. |
+| `CODE_OF_CONDUCT.md` | Microsoft code of conuct. |
+| `LICENSE`         | The license for the sample. |
 
 ## Prerequisites
 
-Outline the required components and tools that a user might need to have on their machine in order to run the sample. This can be anything from frameworks, SDKs, OS versions or IDE releases.
-
-## Setup
-
-Explain how to prepare the sample once the user clones or downloads the repository. The section should outline every step necessary to install dependencies and set up any settings (for example, API keys and output folders).
+This repository is attached to one or more Azure Arc enabled Kubernetes clusters.
 
 ## Running the sample
 
-Outline step-by-step instructions to execute the sample and see its output. Include steps for executing the sample from the IDE, starting specific services in the Azure portal or anything related to the overall launch of the code.
+Create a GitOps configuration by using the Azure CLI extension `k8sconfiguration` referencing this sample repo.
 
-## Key concepts
+After a configuration is created Azure Arc enabled Kubernetes will instantiate the resources described in this repository. Which includes creating namespaces, deploying an example container, and updating a config map.
 
-Provide users with more context on the tools and services used in the sample. Explain some of the code that is being used and how services interact with each other.
+```console
+az k8sconfiguration create \
+    --name cluster-config \
+    --cluster-name ${CLUSTER_NAME} --resource-group ${RESOURCE_GROUP} \
+    --operator-instance-name cluster-config --operator-namespace cluster-config \
+    --repository-url https://github.com/Azure/arc-k8s-demo \
+    --scope cluster --cluster-type connectedClusters
+```
 
 ## Contributing