Merge pull request #57 from coryschwartz/feat/docs

initial readthedocs

Author: cooktheryan

.readthedocs.yaml

@@ -0,0 +1,25 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    golang: "1.18"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/doctrees/environment.pickle

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 2723b11e89b02bc2c195e1cc24e85eee
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/doctrees/getting_started.doctree

@@ -0,0 +1,22 @@
+Getting Started
+===================================
+
+This document explains methods that can be used to install the operator onto an existing kubernetes cluster.
+
+No matter which method you choose, the same operator will be installed.
+
+**With helm**
+::
+helm install ipfs-operator ./helm/ipfs-operator
+
+**manually**
+::
+make install
+
+
+
+Confirm that the operator is installed.
+
+When the operator is installed, a new namespace will be created. Verify the operator is running in the `ipfs-operator` namespace.
+
+Once the operator is installed, you can proceed with installing your first cluster.

docs/build/doctrees/hacking.doctree

@@ -0,0 +1,19 @@
+Hacking
+===================================
+
+Have you have found a bug in the operator or do you have an additional feature? That's great! Here are some tips.
+
+
+Running your own images.
+
+If you have edited the code, you would like to install it in your own cluster, you will first need an account on an image host like dockerhub. Once you have this, you can build, push, and install the image using the **IMG** environment variable
+::
+  export IMG=your-image-repo/ipfs-operator:version
+  make docker-build
+  make docker-push
+  make install
+
+
+Creating a pull request
+
+Pull requests are welcome and encouraged. Please make pull reqeusts against https://github.com/redhat-et/ipfs-operator.