Merge pull request #1615 from splunk/CSPL-4237-improve-github-page

CSPL-4237 improve GitHub page

- Added configuration files for Jekyll-based documentation site.
- Created a .gitignore file for the docs directory to exclude build artifacts.
- Updated multiple documentation files with front matter for better organization and navigation.
- Enhanced existing documentation with additional sections on deployment, health checks, and security considerations.

Author: kubabuczak

.gitignore

@@ -82,6 +82,7 @@ tags
 .yq_script.yaml
 Gopkg.lock
 vendor/
+.bundle/
 push_targets
 splunk-enterprise.lic
 splunk-operator-*.yaml

Makefile

@@ -139,6 +139,15 @@ test: manifests generate fmt vet envtest ## Run tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use ${ENVTEST_K8S_VERSION} --bin-dir $(LOCALBIN) -p path)" ginkgo --junit-report=unit_test.xml --output-dir=`pwd` -vv --trace --keep-going --timeout=3h --cover --covermode=count --coverprofile=coverage.out ./pkg/splunk/common ./pkg/splunk/enterprise ./pkg/splunk/client ./pkg/splunk/util ./internal/controller ./pkg/splunk/splkcontroller
 
 
+##@ Documentation
+
+docs-preview: ## Preview documentation locally with Jekyll (requires Ruby and bundler)
+	@echo "Installing dependencies locally..."
+	@cd docs && bundle config set --local path 'vendor/bundle' && bundle config set --local deployment 'false' && bundle install
+	@echo "Starting Jekyll server for documentation preview..."
+	@cd docs && bundle exec jekyll serve --livereload
+	@echo "Documentation available at http://localhost:4000/splunk-operator"
+
 ##@ Build
 
 build: setup/ginkgo manifests generate fmt vet ## Build manager binary.

README.md

@@ -0,0 +1,3 @@
+_site/
+.bundle/
+Gemfile.lock

docs/.gitignore

@@ -1,3 +1,10 @@
+---
+title: App Framework
+parent: Operate & Manage
+nav_order: 2
+---
+
+
 # App Framework Resource Guide
 
 - [About App Framework](#about-app-framework)
@@ -1647,4 +1654,4 @@ INFO	initAndCheckAppInfoStatus	Apps List retrieved from remote storage	{"control
 Keep in mind that based on the `appsRepoStatusPollIntervalSeconds`, it might take some time for the apps to get updated. Please wait the required amount of time for the app framework to poll the latest versions from storage.
 
 ### App is not correctly copying to pod
-If an app is packaged on a Mac, there might be issues extracting the contents on the running pod. If there are issues installing apps that were packaged manually, ensure that they can be extracted in a Linux environment before uploading it to the remote storage.
+If an app is packaged on a Mac, there might be issues extracting the contents on the running pod. If there are issues installing apps that were packaged manually, ensure that they can be extracted in a Linux environment before uploading it to the remote storage.

docs/AppFramework.md

@@ -1,3 +1,10 @@
+---
+title: Bias Language Migration
+parent: Reference
+nav_order: 4
+---
+
+
 # FAQ - Biased Language Migration