Introduce style guide

.editorconfig

@@ -0,0 +1,26 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{y*ml,*json*,*sonnet}]
+indent_style = space
+indent_size = 2
+
+[*.*sonnet]
+# C-style doc comments
+block_comment_start = /*
+block_comment = *
+block_comment_end = */
+
+[.gitkeep]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.github/workflows/test.yml

@@ -17,6 +17,14 @@ jobs:
       - name: Run ${{ matrix.command }}
         run: make ${{ matrix.command }}
 
+  editorconfig:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: snow-actions/eclint@v1.0.1
+        with:
+          args: 'check'
+
   docs:
     runs-on: ubuntu-latest
     steps:

LICENSE

@@ -1,20 +1,20 @@
 Copyright (c) 2019, VSHN AG, info@vshn.ch
 All rights reserved.
- 
+
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
- 
+
 * Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
- 
+
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
- 
+
 * Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
- 
+
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -24,4 +24,4 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

docs/modules/ROOT/nav.adoc

@@ -56,6 +56,7 @@ include::steward:ROOT:partial$nav-howtos.adoc[]
 --
 
 .Technical reference
+* xref:references/style-guide.adoc[Style Guide]
 * xref:references/labels-guide.adoc[Labels Guide]
 * Commodore
 +

docs/modules/ROOT/pages/.vale.ini

@@ -7,4 +7,3 @@ MinAlertLevel = warning # suggestion, warning or error
 # Using the Microsoft style
 BasedOnStyles = Microsoft
 Microsoft.GenderBias = warning
-

docs/modules/ROOT/pages/about/architecture.adoc

@@ -60,7 +60,7 @@ Configuration Git repositories       ^                 |
 |Configuration generator leveraging a hierarchical configuration model. Uses https://kapitan.dev/[Kapitan] under the hood.
 
 |xref:lieutenant-operator:ROOT:index.adoc[Lieutenant Operator]
-|Manages the CRDs `Cluster`, `Tenant`, `GitRepo`. Implements the business logic for handling all aspects around Git repositories for clusters and tenants. 
+|Manages the CRDs `Cluster`, `Tenant`, `GitRepo`. Implements the business logic for handling all aspects around Git repositories for clusters and tenants.
 
 |xref:lieutenant-api:ROOT:index.adoc[Lieutenant API]
 |REST API to expose the functionality of the Lieutenant Operator and to enforce some defaults.

docs/modules/ROOT/pages/about/community.adoc

@@ -8,4 +8,4 @@ https://github.com/projectsyn[GitHub]:: The source code and issue tracking is av
 [discrete]
 == Project sponsor
 
-The project is sponsored by https://vshn.ch/[VSHN AG]. If you ever need support for Project Syn, have a look at https://kb.vshn.ch/products/vss_intro.html[VSHN Syn Support].
+The project is sponsored by https://vshn.ch/[VSHN AG]. If you ever need support for Project Syn, have a look at https://kb.vshn.ch/products/vss_intro.html[VSHN Syn Support].

docs/modules/ROOT/pages/about/contribution_guide.adoc

@@ -10,6 +10,7 @@ done (read more about http://help.github.com/pull-requests/[pull requests]).
 
 == Coding conventions
 
-=== Commodore Components
+See:
 
-We're using `jsonnetfmt` and `yamllint` to ensure consistency. The `Makefile` provides targets to invoke them.
+* xref:references/style-guide.adoc[Style Guide]
+* xref:references/labels-guide.adoc[Labels Guide]

docs/modules/ROOT/pages/about/glossary.adoc

@@ -16,4 +16,4 @@ Synthesize::
 
 Make a Kubernetes cluster Project Syn managed.
 This is done by registering a cluster in Lieutenant and installing Steward
-on the target cluster.
+on the target cluster.

docs/modules/ROOT/pages/how-tos/release-process.adoc

@@ -42,4 +42,4 @@ If a "major" release is being done, the following additional work needs to be do
 
 * Update the https://github.com/projectsyn/documentation/blob/master/docs/modules/ROOT/pages/roadmap.adoc[Roadmap]
 * Write a blogpost and spread it on social media
-* Close the associated GitHub project and internal Jira project (if applicable)
+* Close the associated GitHub project and internal Jira project (if applicable)