docs: update for Tilt v0.27.1 (#37)

* Fix compiliation on Go 1.18 for macOS (upgrade `golang.org/x/sys`)
* Set `go.mod` version as 1.18
* Update TOC now that `DockerComposeService` exists
* Tiltfile tweaks

Author: milas

Makefile

@@ -4,6 +4,8 @@ gendocs:
 	rm -fR docs/core
 	rm -fR docs/interface
 	rm -fR docs/kubernetes
+	rm -fR docs/container-images
+	rm -fR docs/docker-compose
 	rm -fR docs/meta
 	rm -fR docs/other-resources
 	rm -fR docs/common-parameters

Tiltfile

@@ -9,7 +9,7 @@ local_resource(
 local_resource(
   name='gendocs',
   cmd='make gendocs',
-  deps=['Makefile', './config', './openapi-spec'])
+  deps=['Makefile', 'go.mod', 'go.sum', './cmd/gendocs', './config', './openapi-spec'])
 
 docker_build(
   'api-site-base',

config/toc.yaml

@@ -34,22 +34,6 @@ parts:
     group: tilt.dev
     version: v1alpha1
     slugname: cluster
-  - name: CmdImage
-    group: tilt.dev
-    version: v1alpha1
-    slugname: cmd-image
-  - name: DockerImage
-    group: tilt.dev
-    version: v1alpha1
-    slugname: docker-image
-  - name: LiveUpdate
-    group: tilt.dev
-    version: v1alpha1
-    slugname: live-update
-  - name: ImageMap
-    group: tilt.dev
-    version: v1alpha1
-    slugname: image-map
   - name: KubernetesApply
     group: tilt.dev
     version: v1alpha1
@@ -86,6 +70,32 @@ parts:
     version: v1alpha1
     slugname: toggle-button
 
+- name: Container Images
+  chapters:
+  - name: CmdImage
+    group: tilt.dev
+    version: v1alpha1
+    slugname: cmd-image
+  - name: DockerImage
+    group: tilt.dev
+    version: v1alpha1
+    slugname: docker-image
+  - name: LiveUpdate
+    group: tilt.dev
+    version: v1alpha1
+    slugname: live-update
+  - name: ImageMap
+    group: tilt.dev
+    version: v1alpha1
+    slugname: image-map
+
+- name: Docker Compose
+  chapters:
+  - name: DockerComposeService
+    group: tilt.dev
+    version: v1alpha1
+    slugname: docker-compose-service
+
 - name: Meta
   chapters:
   - name: DeleteOptions

docs/_layouts/api.html

@@ -12,10 +12,10 @@
           {% if href != "https://api.tilt.dev" %}
             {% assign href = link.href | prepend: site.docsurl %}
             {% assign hrefMobile = link.hrefMobile | prepend: site.docsurl %}
-          {% endif %}  
+          {% endif %}
           <li class="Docs-nav-list-item">
             <a class="Docs-nav-link Docs-nav-link--desktop{% if page.sidebar == link.active %} is-active{% endif %}" href="{{href | escape}}">
-              {{link.title | escape}} 
+              {{link.title | escape}}
             </a>
             <!-- On mobile, top-level nav goes to a separate page with subnav links -->
             <a class="Docs-nav-link Docs-nav-link--mobile{% if page.sidebar == link.active %} is-active{% endif %}" href="{{hrefMobile | escape}}">
@@ -49,19 +49,19 @@
           <dd class="js-accordion__panel Docs-subnav-section">
             <ul class="Docs-subnav-section-list">
               {% for chapter in part.chapters %}
-                
+
                 {% assign chapterName = chapter.name %}
                 {% if chapter.slugname %}
                   {% assign chapterName = chapter.slugname %}
                 {% endif %}
-        
+
                 {% assign baseName = chapterName | append: ".html" %}
                 {% if chapter.version %}
                   {% assign baseName = chapterName | append: "-" | append: chapter.version | append: ".html" %}
                 {% endif %}
 
-                {% assign chapterHref = "/" | append: part.name | append: "/" | append: baseName | downcase %}
-              
+                {% assign chapterHref = "/" | append: part.name | replace: " ", "-" | append: "/" | append: baseName | downcase %}
+
                 <li class="Docs-subnav-section-list-item">
                   <a class="Docs-subnav-link{% if page.url == chapterHref %} is-active{% endif %}"
                      href="{{chapterHref}}">
@@ -72,13 +72,13 @@
             </ul>
           </dd>
           {% endfor %}
-        </dl>  
+        </dl>
       </nav>
     </aside>
-  
+
     <article class="Docs-content">
       <h1>{{ page.title | escape }}</h1>
-    
+
       {{ content }}
     </article>
   </div>

docs/common-parameters/common-parameters.md

@@ -7,7 +7,7 @@ api_metadata:
 content_type: "api_reference"
 description: ""
 title: "Common Parameters"
-weight: 6
+weight: 8
 ---
 
 

docs/container-images/_index.md

@@ -0,0 +1,4 @@
+---
+title: "Container Images"
+weight: 4
+---

docs/kubernetes/cmd-image-v1alpha1.md renamed to docs/container-images/cmd-image-v1alpha1.md

@@ -7,7 +7,7 @@ api_metadata:
 content_type: "api_reference"
 description: "CmdImage describes an image to build with an arbitrary shell command."
 title: "CmdImage v1alpha1"
-weight: 2
+weight: 1
 ---
 
 `apiVersion: tilt.dev/v1alpha1`
@@ -33,10 +33,10 @@ CmdImage describes an image to build with an arbitrary shell command.
 - **metadata** ([ObjectMeta](../meta/object-meta#ObjectMeta))
 
 
-- **spec** ([CmdImageSpec](../kubernetes/cmd-image-v1alpha1#CmdImageSpec))
+- **spec** ([CmdImageSpec](../container-images/cmd-image-v1alpha1#CmdImageSpec))
 
 
-- **status** ([CmdImageStatus](../kubernetes/cmd-image-v1alpha1#CmdImageStatus))
+- **status** ([CmdImageStatus](../container-images/cmd-image-v1alpha1#CmdImageStatus))
 
 
 
@@ -58,6 +58,20 @@ CmdImageSpec describes how the custom script builds images and where it puts the
 
   Command-line arguments. Must have length at least 1.
 
+- **cluster** (string)
+
+  The name of the cluster we're building for.
+  
+  We'll use the cluster to determine the architecture of the image to build, and the registry to build it for.
+  
+  If no cluster is specified, assumes the default cluster.
+
+- **clusterNeeds** (string)
+
+  Whether the cluster needs access to the image.
+  
+  If not specified, assumes we have to push up to the cluster.
+
 - **dir** (string)
 
   Process working directory.
@@ -183,7 +197,7 @@ CmdImageList
 - **metadata** ([ListMeta](../meta/list-meta#ListMeta))
 
 
-- **items** ([][CmdImage](../kubernetes/cmd-image-v1alpha1#CmdImage)), required
+- **items** ([][CmdImage](../container-images/cmd-image-v1alpha1#CmdImage)), required
 
 
 

docs/kubernetes/docker-image-v1alpha1.md renamed to docs/container-images/docker-image-v1alpha1.md

@@ -7,7 +7,7 @@ api_metadata:
 content_type: "api_reference"
 description: "DockerImage describes an image to build with Docker."
 title: "DockerImage v1alpha1"
-weight: 3
+weight: 2
 ---
 
 `apiVersion: tilt.dev/v1alpha1`
@@ -33,10 +33,10 @@ DockerImage describes an image to build with Docker.
 - **metadata** ([ObjectMeta](../meta/object-meta#ObjectMeta))
 
 
-- **spec** ([DockerImageSpec](../kubernetes/docker-image-v1alpha1#DockerImageSpec))
+- **spec** ([DockerImageSpec](../container-images/docker-image-v1alpha1#DockerImageSpec))
 
 
-- **status** ([DockerImageStatus](../kubernetes/docker-image-v1alpha1#DockerImageStatus))
+- **status** ([DockerImageStatus](../container-images/docker-image-v1alpha1#DockerImageStatus))
 
 
 
@@ -70,6 +70,20 @@ Most fields of this spec directly correspond to the Docker CLI.
 
   Equivalent to `--cache-from` in the Docker CLI.
 
+- **cluster** (string)
+
+  The name of the cluster we're building for.
+  
+  We'll use the cluster to determine the architecture of the image to build, and the registry to build it for.
+  
+  If no cluster is specified, assumes the default cluster.
+
+- **clusterNeeds** (string)
+
+  Whether the cluster needs access to the image.
+  
+  If not specified, assumes we have to push up to the cluster.
+
 - **context** (string)
 
   Context specifies the Docker build context.
@@ -268,7 +282,7 @@ DockerImageList
 - **metadata** ([ListMeta](../meta/list-meta#ListMeta))
 
 
-- **items** ([][DockerImage](../kubernetes/docker-image-v1alpha1#DockerImage)), required
+- **items** ([][DockerImage](../container-images/docker-image-v1alpha1#DockerImage)), required
 
 
 

docs/kubernetes/image-map-v1alpha1.md renamed to docs/container-images/image-map-v1alpha1.md

@@ -7,7 +7,7 @@ api_metadata:
 content_type: "api_reference"
 description: "ImageMap expresses the mapping from an image reference to a real, pushed image in an image registry that a container runtime can access."
 title: "ImageMap v1alpha1"
-weight: 5
+weight: 4
 ---
 
 `apiVersion: tilt.dev/v1alpha1`
@@ -41,10 +41,10 @@ ImageMap doesn't follow the usual Kubernetes-style API semantics (where the Stat
 - **metadata** ([ObjectMeta](../meta/object-meta#ObjectMeta))
 
 
-- **spec** ([ImageMapSpec](../kubernetes/image-map-v1alpha1#ImageMapSpec))
+- **spec** ([ImageMapSpec](../container-images/image-map-v1alpha1#ImageMapSpec))
 
 
-- **status** ([ImageMapStatus](../kubernetes/image-map-v1alpha1#ImageMapStatus))
+- **status** ([ImageMapStatus](../container-images/image-map-v1alpha1#ImageMapStatus))
 
 
 
@@ -66,28 +66,6 @@ ImageMapSpec defines the desired state of ImageMap
 
   By default, this selector will match an image if the names match (tags on both the selector and the matched reference are ignored).
 
-- **disableSource** (DisableSource)
-
-  Specifies how to disable this.
-
-  <a name="DisableSource"></a>
-  *Points at a thing that can control whether something is disabled*
-
-  - **disableSource.configMap** (ConfigMapDisableSource)
-
-    This DisableSource is controlled by a ConfigMap
-
-    <a name="ConfigMapDisableSource"></a>
-    *Specifies a ConfigMap to control a DisableSource*
-
-  - **disableSource.configMap.key** (string), required
-
-    The key where the enable/disable state is stored.
-
-  - **disableSource.configMap.name** (string), required
-
-    The name of the ConfigMap
-
 - **matchExact** (boolean)
 
   If specified, then tags on both the selector and the matched reference are used for matching. The selector will only match the reference if the tags match exactly.
@@ -182,7 +160,7 @@ ImageMapList
 - **metadata** ([ListMeta](../meta/list-meta#ListMeta))
 
 
-- **items** ([][ImageMap](../kubernetes/image-map-v1alpha1#ImageMap)), required
+- **items** ([][ImageMap](../container-images/image-map-v1alpha1#ImageMap)), required
 
 
 

docs/kubernetes/live-update-v1alpha1.md renamed to docs/container-images/live-update-v1alpha1.md

@@ -7,7 +7,7 @@ api_metadata:
 content_type: "api_reference"
 description: "LiveUpdate."
 title: "LiveUpdate v1alpha1"
-weight: 4
+weight: 3
 ---
 
 `apiVersion: tilt.dev/v1alpha1`
@@ -33,10 +33,10 @@ LiveUpdate
 - **metadata** ([ObjectMeta](../meta/object-meta#ObjectMeta))
 
 
-- **spec** ([LiveUpdateSpec](../kubernetes/live-update-v1alpha1#LiveUpdateSpec))
+- **spec** ([LiveUpdateSpec](../container-images/live-update-v1alpha1#LiveUpdateSpec))
 
 
-- **status** ([LiveUpdateStatus](../kubernetes/live-update-v1alpha1#LiveUpdateStatus))
+- **status** ([LiveUpdateStatus](../container-images/live-update-v1alpha1#LiveUpdateStatus))
 
 
 
@@ -65,6 +65,19 @@ LiveUpdateSpec defines the desired state of LiveUpdate
 
   Every live update must be associated with some object for finding containers. In the future, we expect there to be other types of container discovery objects (like Docker Compose container discovery).*
 
+  - **selector.dockerCompose** (LiveUpdateDockerComposeSelector)
+
+    Finds containers in Docker Compose.
+
+    <a name="LiveUpdateDockerComposeSelector"></a>
+    *Specifies how to select containers to live update inside Docker Compose.*
+
+  - **selector.dockerCompose.service** (string), required
+
+    The name of a DockerComposeService object.
+    
+    For simple projects, this is usually the same as the service name in the docker-compose.yml file. (But it doesn't necessarily have to be.)
+
   - **selector.kubernetes** (LiveUpdateKubernetesSelector)
 
     Finds containers in Kubernetes.
@@ -281,7 +294,7 @@ LiveUpdateList
 - **metadata** ([ListMeta](../meta/list-meta#ListMeta))
 
 
-- **items** ([][LiveUpdate](../kubernetes/live-update-v1alpha1#LiveUpdate)), required
+- **items** ([][LiveUpdate](../container-images/live-update-v1alpha1#LiveUpdate)), required