Move static file from kunit-doc to kunit-website
Move static files (like README.md and CNAME) to kunit-website so that
all files in kunit-doc are maintained here. This should make updating
the website and maintaining it easier.
Signed-off-by: Brendan Higgins <brendanhiggins@google.com>
Change-Id: I1ed7292fee1268275fc1e438552d739b6908211a
diff --git a/Makefile b/Makefile
index 137bfd1..533b746 100644
--- a/Makefile
+++ b/Makefile
@@ -48,14 +48,21 @@
$(call fetch_kernel_docs,https://kunit.googlesource.com/linux,kunit/alpha/master,$(BUILDDIR)/stable_kunit,stable_kernel,test)
fetch_upstream_docs:
- $(call fetch_kernel_docs,https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git,next,$(BUILDDIR)/upstream_kunit,kernel,dev-tools/kunit)
+ $(call fetch_kernel_docs,https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git,test,$(BUILDDIR)/upstream_kunit,kernel,dev-tools/kunit)
download_deps: fetch_stable_docs fetch_upstream_docs
+copy_statics:
+ cp LICENSE $(BUILDDIR)/html/
+ cp CONTRIBUTING.md $(BUILDDIR)/html/
+ cp statics/CNAME $(BUILDDIR)/html/
+ cp statics/.nojekyll $(BUILDDIR)/html/
+ cp statics/README.md $(BUILDDIR)/html/
+
clean:
rm -rf $(BUILDDIR)
-.PHONY: all fetch_stable_docs fetch_upstream_docs download_deps clean html
+.PHONY: all fetch_stable_docs fetch_upstream_docs download_deps clean html copy_statics
-html: Makefile download_deps
+html: Makefile download_deps copy_statics
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/README.md b/README.md
index a6a785a..645492e 100644
--- a/README.md
+++ b/README.md
@@ -34,3 +34,18 @@
make html
```
+## How to update the documentation
+
+Our documentation is hosted at <http://github.com/google/kunit-docs>. The
+documentation may be updated by building the documentation as described above,
+and then:
+
+```bash
+git clone http://github.com/google/kunit-docs.git
+cd kunit-docs/
+git ls-files -z | xargs -0 rm -f
+cp -r ../kunit-website/_build/html/* ./
+git add -A
+git commit
+git push -u origin
+```
diff --git a/statics/.nojekyll b/statics/.nojekyll
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/statics/.nojekyll
diff --git a/statics/CNAME b/statics/CNAME
new file mode 100644
index 0000000..90ea859
--- /dev/null
+++ b/statics/CNAME
@@ -0,0 +1 @@
+kunit.dev
\ No newline at end of file
diff --git a/statics/README.md b/statics/README.md
new file mode 100644
index 0000000..335c32d
--- /dev/null
+++ b/statics/README.md
@@ -0,0 +1,7 @@
+# KUnit Documentation Website
+
+This documentation is generated from
+<https://kunit.googlesource.com/kunit-website>. To update this website, please
+see the instructions listed there.
+
+Otherwise, visit <https://kunit.dev> for more information about the project.
