Move docs out of repo

The user documentation has moved to a new repository at https://github.com/crc-org/docs
crc-org · Dec 2, 2024 · 598ea18 · 598ea18
1 parent 8ee8e71
commit 598ea18
Show file tree

Hide file tree

Showing 59 changed files with 5 additions and 1,603 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
diff --git a/.htmltest.yml b/.htmltest.yml
diff --git a/.vale.ini b/.vale.ini
diff --git a/Makefile b/Makefile
@@ -19,13 +19,6 @@ BUILD_DIR ?= out
 SOURCE_DIRS = cmd pkg test
 RELEASE_DIR ?= release
 
-# Docs build related variables
-DOCS_BUILD_DIR ?= docs/build
-DOCS_BUILD_CONTAINER ?= quay.io/crcont/antora:latest
-DOCS_SERVE_CONTAINER ?= docker.io/httpd:alpine
-DOCS_TEST_CONTAINER ?= docker.io/wjdp/htmltest:latest
-DOCS_BUILD_TARGET ?= /docs/source/getting_started/master.adoc
-
 GOOS ?= $(shell go env GOOS)
 GOARCH ?= $(shell go env GOARCH)
 GOVERSION = 1.22
@@ -148,22 +141,6 @@ test-rpmbuild: spec
 	${CONTAINER_RUNTIME} rm test-rpmbuild
 	${CONTAINER_RUNTIME} rmi test-rpmbuild-img
 
-.PHONY: build_docs
-build_docs:
-	${CONTAINER_RUNTIME} run -v $(CURDIR):/antora$(SELINUX_VOLUME_LABEL) --rm $(DOCS_BUILD_CONTAINER) --stacktrace antora-playbook.yml
-
-.PHONY: docs_serve
-docs_serve: build_docs
-	${CONTAINER_RUNTIME} run -it -v $(CURDIR)/docs/build:/usr/local/apache2/htdocs/$(SELINUX_VOLUME_LABEL) --rm -p 8088:80/tcp $(DOCS_SERVE_CONTAINER)
-
-.PHONY: docs_check_links
-docs_check_links:
-	${CONTAINER_RUNTIME} run -v $(CURDIR):/test$(SELINUX_VOLUME_LABEL) --rm $(DOCS_TEST_CONTAINER) -c .htmltest.yml
-
-.PHONY: clean_docs clean_macos_package
-clean_docs:
-	rm -rf $(CURDIR)/docs/build
-
 clean_macos_package:
 	rm -f packaging/darwin/Distribution
 	rm -f packaging/darwin/Resources/welcome.html
@@ -175,7 +152,7 @@ clean_windows_msi:
 	rm -f $(HOST_BUILD_DIR)/split
 
 .PHONY: clean ## Remove all build artifacts
-clean: clean_docs clean_macos_package clean_windows_msi
+clean: clean_macos_package clean_windows_msi
 	rm -f $(GENERATED_RPM_FILES)
 	rm -rf $(BUILD_DIR)
 	rm -f $(GOPATH)/bin/crc

diff --git a/antora-playbook.yml b/antora-playbook.yml
diff --git a/docs/Containerfile b/docs/Containerfile
diff --git a/docs/OWNERS b/docs/OWNERS
diff --git a/docs/README.adoc b/docs/README.adoc
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,4 @@
+CRC - Getting Started Guide
+===========================
+
+The user documentation has moved to https://github.com/crc-org/docs
diff --git a/docs/antora.yml b/docs/antora.yml
diff --git a/docs/extensions/get-versions.js b/docs/extensions/get-versions.js
diff --git a/docs/modules/getting_started/examples/snip_crc_preset_list.adoc b/docs/modules/getting_started/examples/snip_crc_preset_list.adoc
diff --git a/docs/modules/getting_started/examples/snip_crc_preset_names.adoc b/docs/modules/getting_started/examples/snip_crc_preset_names.adoc
diff --git a/docs/modules/getting_started/examples/snip_crc_preset_platforms.adoc b/docs/modules/getting_started/examples/snip_crc_preset_platforms.adoc
diff --git a/docs/modules/getting_started/nav.adoc b/docs/modules/getting_started/nav.adoc
diff --git a/docs/modules/getting_started/pages/administrative-tasks.adoc b/docs/modules/getting_started/pages/administrative-tasks.adoc
diff --git a/docs/modules/getting_started/pages/configuring.adoc b/docs/modules/getting_started/pages/configuring.adoc
diff --git a/docs/modules/getting_started/pages/installing.adoc b/docs/modules/getting_started/pages/installing.adoc
diff --git a/docs/modules/getting_started/pages/introducing.adoc b/docs/modules/getting_started/pages/introducing.adoc
diff --git a/docs/modules/getting_started/pages/networking.adoc b/docs/modules/getting_started/pages/networking.adoc
diff --git a/docs/modules/getting_started/pages/troubleshooting.adoc b/docs/modules/getting_started/pages/troubleshooting.adoc