write a very simple getting started guide

docs-src/getting-started.md

@@ -0,0 +1,56 @@
+# Getting started with Services APIs
+
+## Installing CRDs
+
+This project provides a collection of Custom Resource Definitions (CRDs)that can
+be installed into any Kubernetes (>= 1.16) cluster.
+
+To install the CRDs, please execute:
+
+```
+kubectl kustomize "github.com/kubernetes-sigs/service-apis/config/crd?ref=master" \
+| kubectl apply -f -
+```
+
+## Install an implementation
+
+Multiple projects implement the APIs defined by this project.
+You will need to either install an implementation or verify if one is already
+setup for your cluster.
+
+## Sample Gateway
+
+Once you have the CRDs and an implementation installed, you are ready to
+use Service APIs.
+
+In this example, we are installing three resources:
+
+- An `acme-lb` GatewayClass which is being managed by a `acme.io/gateway-controller`
+  controller running in the cluster.
+- A Gateway which is of type `acme-lb`:
+    - This gateway has a single HTTP listener on port 80 which selects HTTPRoutes
+      from all namespaces which have the label `app: foo` on them.
+
+- Finally, we have an HTTPRoute resource which is attached to the above Gateway
+  and has two rules:
+    - All requests with path beginning with `/bar` are forwarded to my-service1
+      Kubernetes Service.
+    - All requests with path beginning with `/some/thing` AND have an HTTP header
+      `magic: foo` are forwarded to my-service2 Kubernetes Service.
+
+With this configuration, you now have a Gateway reource which is forwarding
+traffic to two Kubernetes Services based on HTTP request metadata.
+
+```
+{% include 'basic-http.yaml' %}
+```
+
+For more advanced examples, please checkout other [guides](guides.md).
+
+## Uninstalling the CRDs
+
+```
+kubectl kustomize "github.com/kubernetes-sigs/service-apis/config/crd?ref=master" \
+| kubectl delete -f -
+```
+

docs-src/guides.md

@@ -3,4 +3,5 @@
 Guides demonstrate and provide examples of how to use the API.
 Please checkout one of the following guides:
 
+- [Getting started](getting-started.md)
 - [Configuring TLS](tls.md)

docs/404.html

@@ -261,6 +261,18 @@
 
 
 
+  <li class="md-nav__item">
+    <a href="/getting-started/" title="Getting started" class="md-nav__link">
+      Getting started
+    </a>
+  </li>
+
+
+
+
+
+
+
   <li class="md-nav__item">
     <a href="/tls/" title="TLS" class="md-nav__link">
       TLS

docs/community/index.html

@@ -265,6 +265,18 @@
 
 
 
+  <li class="md-nav__item">
+    <a href="../getting-started/" title="Getting started" class="md-nav__link">
+      Getting started
+    </a>
+  </li>
+
+
+
+
+
+
+
   <li class="md-nav__item">
     <a href="../tls/" title="TLS" class="md-nav__link">
       TLS

docs/concepts/index.html

@@ -536,6 +536,18 @@
 
 
 
+  <li class="md-nav__item">
+    <a href="../getting-started/" title="Getting started" class="md-nav__link">
+      Getting started
+    </a>
+  </li>
+
+
+
+
+
+
+
   <li class="md-nav__item">
     <a href="../tls/" title="TLS" class="md-nav__link">
       TLS

docs/devguide/index.html

@@ -265,6 +265,18 @@
 
 
 
+  <li class="md-nav__item">
+    <a href="../getting-started/" title="Getting started" class="md-nav__link">
+      Getting started
+    </a>
+  </li>
+
+
+
+
+
+
+
   <li class="md-nav__item">
     <a href="../tls/" title="TLS" class="md-nav__link">
       TLS

docs/enhancement-requests/index.html

@@ -265,6 +265,18 @@
 
 
 
+  <li class="md-nav__item">
+    <a href="../getting-started/" title="Getting started" class="md-nav__link">
+      Getting started
+    </a>
+  </li>
+
+
+
+
+
+
+
   <li class="md-nav__item">
     <a href="../tls/" title="TLS" class="md-nav__link">
       TLS

docs/faq/index.html

@@ -265,6 +265,18 @@
 
 
 
+  <li class="md-nav__item">
+    <a href="../getting-started/" title="Getting started" class="md-nav__link">
+      Getting started
+    </a>
+  </li>
+
+
+
+
+
+
+
   <li class="md-nav__item">
     <a href="../tls/" title="TLS" class="md-nav__link">
       TLS