Add documentation Page (#1166)

No-Issue
ansible · Mar 15, 2022 · bb1ce0f · bb1ce0f
1 parent 49d505e
commit bb1ce0f
Show file tree

Hide file tree

Showing 11 changed files with 83 additions and 13 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -8,3 +8,6 @@ include requirements/requirements.common.txt
 graft galaxy_ng/app/webserver_snippets
 graft galaxy_ng/app/static
 graft galaxy_ng/locale
+exclude mkdocs.yml
+exclude docs
+exclude docs_requirements.txt
diff --git a/Makefile b/Makefile
@@ -88,11 +88,11 @@ docker/loaddata:  ## Load initial data from fixtures
  api manage loaddata initial_data.json
 
 .PHONY: docker/loadtoken
-docker/loadtoken: 
+docker/loadtoken:
 	./compose run --rm api manage shell < dev/standalone/create_admin_token.py
 
 .PHONY: docker/load_test_data
-docker/load_test_data: 
+docker/load_test_data:
 	./compose run --rm api manage shell < dev/ephemeral/create_objects.py
 
 .PHONY: docker/makemigrations
@@ -199,3 +199,12 @@ dev/bumpversion-build:
 # another 'bumpversion release' to from from 5.3.7.b1 -> 5.3.7
 dev/bumpversion-release:
 	bump2version --verbose release
+
+docs/install:
+	@pip install -r docs_requirements.txt
+
+docs/build:
+	@mike deploy --push --update-aliases 4.5.0 latest
+
+docs/serve:
+	@mike serve
diff --git a/doc_requirements.txt b/doc_requirements.txt
diff --git a/docs/configuration.md b/docs/configuration.md
diff --git a/docs/content_signing.md b/docs/content_signing.md
diff --git a/docs/development.md b/docs/development.md
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1,5 @@
+---
+tags:
+  - on-premise
+  - tech preview
+---
diff --git a/docs/tags.md b/docs/tags.md
diff --git a/docs_requirements.txt b/docs_requirements.txt
@@ -0,0 +1,4 @@
+mkdocs
+mkdocs-material
+mike
+mkdocs-git-revision-date-plugin
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,43 @@
+site_name: Galaxy NG - Upstream for Ansible Automation Hub
+site_url: "https://ansible.github.io/galaxy_ng"
+repo_name: ansible/galaxy_ng
+repo_url: "https://github.com/ansible/galaxy_ng"
+edit_uri: edit/master/docs/
+nav:
+    - Home: index.md
+    - Install: installation.md
+    - Configuration: configuration.md
+    - Content Signing: content_signing.md
+    - Development: development.md
+    - Tags: tags.md
+theme:
+  features:
+      - search.suggest
+      - search.highlight
+      - search.share
+  name: material
+  palette:
+    - scheme: default
+      media: "(prefers-color-scheme: light)"
+      primary: teal
+      toggle:
+        icon: material/toggle-switch-off-outline 
+        name: Switch to dark mode
+    - scheme: slate 
+      media: "(prefers-color-scheme: dark)"
+      primary: teal
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
+extra:
+  version:
+    provider: mike
+    default: latest
+
+plugins:
+  - git-revision-date
+  - tags:
+        tags_file: tags.md
+  - search:
+      lang: en
+      prebuild_index: true