Minor fixes for Kanister docs (#4890)

* Minor fixes for Kanister docs Screenshot: https://cl.ly/c32ae248687e * Fix typo
kanisterio · Feb 6, 2019 · be2c0b2 · be2c0b2
1 parent 6a5195a
commit be2c0b2
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 9 deletions.
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -7,7 +7,11 @@ h1, h2, h3, h4, h5, h6 {
 
 body, p {
     font-family: 'Open Sans', sans-serif !important;
-    font-weight: 400 !important;
+    font-weight: 400;
+}
+
+div.body p {
+    line-height: 1.6em;
 }
 
 li {
@@ -20,4 +24,34 @@ li {
 
 div.admonition {
     padding: 1rem 2rem;
+    border-width: 0 0 0 3px;
+}
+
+div.admonition.warning {
+    background-color: #fff3f3;
+    border-color: #FAA;
+}
+
+div.sphinxsidebarwrapper p.logo {
+    margin: -10px 0 3rem -20px;
+}
+
+img.logo {
+    max-width: 80%;
+}
+
+div.topic {
+    padding: 20px 30px;
+    margin: 20px 0 10px 0;
+    border: none;
+    background-color: #edf6fb;
+}
+
+div.sphinxsidebarwrapper #searchbox {
+    margin-top: 2rem;
+}
+
+div.sphinxsidebar #searchbox input {
+    padding: 0.6rem !important;
+    font-family: 'Open Sans', sans-serif;
 }
diff --git a/docs/architecture.rst b/docs/architecture.rst
@@ -183,7 +183,7 @@ As a reference, below is an example of a ActionSpec.
         name: example-profile
         namespace: example-namespace
 
-In addition the Spec, an ActionSet also contains an ActionSetStatus
+In addition to the Spec, an ActionSet also contains an ActionSetStatus
 which mirrors the Spec, but contains the phases of execution, their
 state, and the overall execution progress.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -49,7 +49,7 @@
 
 # General information about the project.
 project = 'Kanister'
-copyright = '2017-2018, Kanister'
+copyright = '2017-2019, Kanister'
 author = 'Kanister'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/templates.rst b/docs/templates.rst
@@ -116,7 +116,7 @@ For example, to access the Name of a Deployment use:
   "{{ index .Deployment.Name }}"
 
 Namespace
----
+---------
 
 NamespaceParams includes the name of the namespace
 that is being acted on when the ActionSet `Object` is
@@ -573,12 +573,12 @@ or as output artifacts using templating.
 
 For example, an output artifact can reference the output from a phase as follows:
 
-.. code-block:: yaml
+.. code-block:: go
 
-"{{ .Phases.phase-name.Output.key-name }}"
+  "{{ .Phases.phase-name.Output.key-name }}"
 
 Similarly, a phase can use Secrets as arguments:
 
-.. code-block:: yaml
+.. code-block:: go
 
-"{{ .Phases.phase-name.Secrets.secret-name.Namespace }}"
+  "{{ .Phases.phase-name.Secrets.secret-name.Namespace }}"
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -65,7 +65,7 @@ the Kanister controller.
 
 The first Kanister CustomResource we're going to deploy is a Blueprint.
 Blueprints are a set of instructions that tell the controller how to perform
-actions on an application. A action consists of one or more phases. Each phase
+actions on an application. An action consists of one or more phases. Each phase
 invokes a :doc:`Kanister Function </functions>`. All Kanister functions accept a
 list of strings. The `args` field in a Blueprint's phase is rendered and passed
 into the specified Function.