Rename examples to templates on the git repo

Also removes `/usr/local/share/lima/examples` (symlink to `templates`).

Follow-up to PR 1679

Fix issue 2808

Signed-off-by: Akihiro Suda <[email protected]>

Author: AkihiroSuda

.github/workflows/test.yml

@@ -109,7 +109,7 @@ jobs:
       run: sudo make install
     - name: Verify templates match `limactl edit` format
       run: |
-        find examples -name '*.yaml' -exec limactl edit --set 'del(.nothing)' {} \;
+        find templates -name '*.yaml' -exec limactl edit --set 'del(.nothing)' {} \;
         git diff-index --exit-code HEAD
     - name: Uninstall
       run: sudo make uninstall

Makefile

@@ -89,7 +89,6 @@ help-targets:
 	@echo  '- templates                 : Copy templates'
 	@echo  '- template_experimentals    : Copy experimental templates to experimental/'
 	@echo  '- default_template          : Copy default.yaml template'
-	@echo  '- create-examples-link      : Create a symlink at ../examples pointing to templates'
 	@echo
 	@echo  'Targets for files in _output/share/doc/lima:'
 	@echo  '- documentation             : Copy documentation to _output/share/doc/lima'
@@ -146,7 +145,7 @@ menuconfig: Kconfig
 ################################################################################
 .PHONY: binaries
 binaries: limactl helpers guestagents \
-	templates template_experimentals create-examples-link \
+	templates template_experimentals \
 	documentation create-links-in-doc-dir
 
 ################################################################################
@@ -313,8 +312,8 @@ MKDIR_TARGETS += _output/share/lima
 
 ################################################################################
 # _output/share/lima/templates
-TEMPLATES = $(addprefix _output/share/lima/templates/,$(filter-out experimental,$(notdir $(wildcard examples/*))))
-TEMPLATE_EXPERIMENTALS = $(addprefix _output/share/lima/templates/experimental/,$(notdir $(wildcard examples/experimental/*)))
+TEMPLATES = $(addprefix _output/share/lima/templates/,$(filter-out experimental,$(notdir $(wildcard templates/*))))
+TEMPLATE_EXPERIMENTALS = $(addprefix _output/share/lima/templates/experimental/,$(notdir $(wildcard templates/experimental/*)))
 
 .PHONY: default_template templates template_experimentals
 default_template: _output/share/lima/templates/default.yaml
@@ -325,28 +324,14 @@ $(TEMPLATES): | _output/share/lima/templates
 $(TEMPLATE_EXPERIMENTALS): | _output/share/lima/templates/experimental
 MKDIR_TARGETS += _output/share/lima/templates _output/share/lima/templates/experimental
 
-_output/share/lima/templates/%: examples/%
+_output/share/lima/templates/%: templates/%
 	cp -aL $< $@
 
 # returns "force" if GOOS==windows, or GOOS!=windows and the file $(1) is not a symlink.
 # $(1): target file
 # On Windows, always copy to ensure the target has the same file as the source.
 force_link = $(if $(filter windows,$(GOOS)),force,$(shell test ! -L $(1) && echo force))
 
-################################################################################
-# _output/share/lima/examples
-.PHONY: create-examples-link
-create-examples-link: _output/share/lima/examples
-_output/share/lima/examples: _output/share/lima/templates $$(call force_link,$$@)
-# remove the existing directory or symlink
-	rm -rf $@
-ifneq ($(GOOS),windows)
-	ln -sf templates $@
-else
-# copy from templates built in build process
-	cp -aL $< $@
-endif
-
 ################################################################################
 # _output/share/doc/lima
 DOCUMENTATION = $(addprefix _output/share/doc/lima/,$(wildcard *.md) LICENSE SECURITY.md VERSION)
@@ -366,7 +351,7 @@ _output/share/doc/lima/%: % | _output/share/doc/lima
 MKDIR_TARGETS += _output/share/doc/lima
 
 .PHONY: create-links-in-doc-dir
-create-links-in-doc-dir: _output/share/doc/lima/templates _output/share/doc/lima/examples
+create-links-in-doc-dir: _output/share/doc/lima/templates
 _output/share/doc/lima/templates: _output/share/lima/templates $$(call force_link,$$@)
 # remove the existing directory or symlink
 	rm -rf $@
@@ -376,15 +361,6 @@ else
 # copy from templates built in build process
 	cp -aL $< $@
 endif
-_output/share/doc/lima/examples: _output/share/doc/lima/templates $$(call force_link,$$@)
-# remove the existing directory or symlink
-	rm -rf $@
-ifneq ($(GOOS),windows)
-	ln -sf templates $@
-else
-# copy from templates built in build process
-	cp -aL $< $@
-endif
 
 ################################################################################
 # returns difference between GOOS GOARCH and GOHOSTOS GOHOSTARCH.
@@ -424,12 +400,12 @@ endif
 ################################################################################
 schema-limayaml.json: _output/bin/limactl$(exe)
 ifeq ($(native_compiling),true)
-	$< generate-jsonschema --schemafile $@ examples/default.yaml
+	$< generate-jsonschema --schemafile $@ templates/default.yaml
 endif
 
 .PHONY: check-jsonschema
 check-jsonschema: schema-limayaml.json
-	check-jsonschema --schemafile $< examples/default.yaml
+	check-jsonschema --schemafile $< templates/default.yaml
 
 ################################################################################
 .PHONY: diagrams
@@ -523,8 +499,8 @@ artifact: $(addprefix $(ARTIFACT_PATH_COMMON),$(ARTIFACT_FILE_EXTENSIONS))
 
 ARTIFACT_DES =  _output/bin/limactl$(exe) $(LIMA_DEPS) $(HELPERS_DEPS) \
 	$(ALL_GUESTAGENTS) \
-	$(TEMPLATES) $(TEMPLATE_EXPERIMENTALS) _output/share/lima/examples \
-	$(DOCUMENTATION) _output/share/doc/lima/templates _output/share/doc/lima/examples \
+	$(TEMPLATES) $(TEMPLATE_EXPERIMENTALS) \
+	$(DOCUMENTATION) _output/share/doc/lima/templates \
 	_output/share/man/man1/limactl.1
 
 # file targets

cmd/limactl/start.go

@@ -57,7 +57,7 @@ To create an instance "default" from a local file:
 $ limactl create --name=default /usr/local/share/lima/templates/fedora.yaml
 
 To create an instance "default" from a remote URL (use carefully, with a trustable source):
-$ limactl create --name=default https://raw.githubusercontent.com/lima-vm/lima/master/examples/alpine.yaml
+$ limactl create --name=default https://raw.githubusercontent.com/lima-vm/lima/master/templates/alpine.yaml
 
 To create an instance "local" from a template passed to stdin (--name parameter is required):
 $ cat template.yaml | limactl create --name=local -

pkg/limayaml/default.yaml

@@ -1 +1 @@
-../../examples/default.yaml
+../../templates/default.yaml

templates

@@ -205,11 +205,11 @@ enable = false
     source="docsy"
     target="content/docs/Reference"
     language="en"
-  # Import examples README.md from examples folder
+  # Import templates README.md from templates folder
   [[module.imports]]
     path="../.."
   [[module.imports.mounts]]
-    source="examples"
-    target="static/examples"
+    source="templates"
+    target="static/templates"
     language="en"
-    includeFiles = "README.md"
+    includeFiles = "README.md"

examples/README.md renamed to templates/README.md

@@ -1,6 +1,6 @@
 {{ $gh_repo := (.Site.Params.github_repo) -}}
 {{ $gh_docs := (printf "%s/tree/%s/docs/" $gh_repo $.Site.Params.version) -}}
-{{ $gh_examples := (printf "%s/tree/%s/examples/" $gh_repo $.Site.Params.version) -}}
+{{ $gh_templates := (printf "%s/tree/%s/templates/" $gh_repo $.Site.Params.version) -}}
 
 {{/* Store ordinal, to be retrieved by parent element */}}
 {{ if ge hugo.Version "0.93.0" }}
@@ -39,10 +39,10 @@
 {{ else }}
 {{ $file_content := ($.Scratch.Get "filepath" | os.ReadFile) }}
 {{ $file_content = replace $file_content "../docs/" $gh_docs }}
-{{- replace $file_content "./" $gh_examples -}}
+{{- replace $file_content "./" $gh_templates -}}
 {{ end }}
 {{ else if eq (.Get "draft") "true" }}
 
 <p style="color: #D74848"><b><i>The file <code>{{ $.Scratch.Get "filepath" }}</code> was not found.</i></b></p>
 
-{{ else }}{{- errorf "Shortcode %q: file %q not found at %s" .Name ($.Scratch.Get "filepath") .Position -}}{{ end }}
+{{ else }}{{- errorf "Shortcode %q: file %q not found at %s" .Name ($.Scratch.Get "filepath") .Position -}}{{ end }}