Merge pull request #30 from planetlabs/docs

Minor doc and make target tweaks

Author: tschaub

Makefile

@@ -14,6 +14,7 @@ help:
 .PHONY: build
 build: ## Rewrite all STAC files referenced by ./stac/catalog.json to use absolute links, write to build/stac dir
 	@docker run \
+		--rm \
 		--volume $$(pwd):/work \
 		$(GO_STAC) make-links-absolute \
 			--entry /work/stac/catalog.json \
@@ -24,6 +25,7 @@ build: ## Rewrite all STAC files referenced by ./stac/catalog.json to use absolu
 .PHONY: validate
 validate: ## Validate all STAC files referenced by ./stac/catalog.json
 	@docker run \
+		--rm \
 		--volume $$(pwd):/work \
 		$(GO_STAC) validate \
 			--entry /work/stac/catalog.json
@@ -32,6 +34,7 @@ validate: ## Validate all STAC files referenced by ./stac/catalog.json
 .PHONY: stats
 stats: ## Add stats metadata to ./stac/catalog.json
 	@docker run \
+		--rm \
 		--volume $$(pwd):/work \
 		$(GO_STAC) stats \
 			--entry /work/stac/catalog.json \
@@ -41,6 +44,7 @@ stats: ## Add stats metadata to ./stac/catalog.json
 .PHONY: format
 format: ## Format all STAC files referenced by ./stac/catalog.json
 	@docker run \
+		--rm \
 		--volume $$(pwd):/work \
 		$(GO_STAC) format \
 			--entry /work/stac/catalog.json \
@@ -69,6 +73,7 @@ build/.browser-$(STAC_BROWSER_SHA):
 .PHONY: preview
 preview: build browser ## Preview the catalog
 	@docker run \
+		--rm \
 		--volume $$(pwd):/work \
 		--publish 8000:8000 \
 		--workdir /work \

README.md

@@ -7,20 +7,19 @@ The catalog should be considered 'in-progress', as not all items are in their id
 
 ### Development
 
-The instructions below currently require access to the private us.gcr.io/planet-gcr registry.  Until that changes, you can skip these `make` commands and rely on CI jobs to make things work.
+The development environment requires [Docker](https://docs.docker.com/get-docker/) and [Make](https://www.gnu.org/software/make/). The instructions below make use the [`ghcr.io/planetlabs/go-stac` image](https://github.com/planetlabs/go-stac/pkgs/container/go-stac). The CI jobs run the same tasks, so if you cannot run them locally, you can rely on the CI jobs.
 
-The development environment requires [Docker](https://docs.docker.com/get-docker/) and [Make](https://www.gnu.org/software/make/).
 
 After adding new STAC resources to the `stac` directory, add links from the root `stac/catalog.json` (or an existing linked collection or catalog).  Use relative URLs for all link `href` values.
 
-To format everything in the `stac` directory:
-
-    make format
-
 To add or update stats for the `stac/catalog.json`:
 
     make stats
 
+To format everything in the `stac` directory:
+
+    make format
+
 To validate all of the resources:
 
     make validate

stac/catalog.json

@@ -67,13 +67,13 @@
     }
   },
   "stats:collections": {
-    "count": 12,
+    "count": 13,
     "extensions": {
       "https://stac-extensions.github.io/version/v1.2.0/schema.json": 3,
       "https://stac-extensions.github.io/web-map-links/v1.1.0/schema.json": 4
     },
     "versions": {
-      "1.0.0": 12
+      "1.0.0": 13
     }
   },
   "stats:items": {
@@ -86,24 +86,24 @@
       "image/png": 17,
       "image/tiff": 3,
       "image/tiff; application=geotiff": 2253,
-      "image/tiff; application=geotiff; profile=cloud-optimized": 437,
+      "image/tiff; application=geotiff; profile=cloud-optimized": 438,
       "text/xml": 4
     },
-    "count": 3722,
+    "count": 3723,
     "extensions": {
       "https://planetlabs.github.io/stac-extension/v1.0.0-beta.3/schema.json": 30,
       "https://stac-extensions.github.io/eo/v1.0.0/schema.json": 2,
-      "https://stac-extensions.github.io/eo/v1.1.0/schema.json": 400,
+      "https://stac-extensions.github.io/eo/v1.1.0/schema.json": 401,
       "https://stac-extensions.github.io/file/v2.0.0/schema.json": 16,
       "https://stac-extensions.github.io/label/v1.0.0/schema.json": 1423,
       "https://stac-extensions.github.io/pointcloud/v1.0.0/schema.json": 4,
-      "https://stac-extensions.github.io/projection/v1.1.0/schema.json": 399,
-      "https://stac-extensions.github.io/raster/v1.1.0/schema.json": 384,
+      "https://stac-extensions.github.io/projection/v1.1.0/schema.json": 400,
+      "https://stac-extensions.github.io/raster/v1.1.0/schema.json": 385,
       "https://stac-extensions.github.io/stereo-imagery/v1.0.0/schema.json": 18,
       "https://stac-extensions.github.io/view/v1.0.0/schema.json": 33
     },
     "versions": {
-      "1.0.0": 3722
+      "1.0.0": 3723
     }
   }
 }