Merge pull request #172 from projectsyn/roadmap-update

Update Project Syn Roadmap for 2023 and beyond

Author: tobru

.github/workflows/test.yml

@@ -10,8 +10,7 @@ jobs:
     strategy:
       matrix:
         command:
-          - lint_yaml
-          - docs-vale
+          - check
     steps:
       - uses: actions/checkout@v2
       - name: Run ${{ matrix.command }}
@@ -23,7 +22,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: snow-actions/eclint@v1.0.1
         with:
-          args: 'check'
+          args: "check"
 
   docs:
     runs-on: ubuntu-latest

CODEOWNERS

@@ -1 +1 @@
-* @projectsyn/tarazed
+* @projectsyn/project-syn-ig

Makefile

@@ -1,38 +1,24 @@
-MAKEFLAGS += --warn-undefined-variables
-SHELL := bash
-.SHELLFLAGS := -eu -o pipefail -c
-.DEFAULT_GOAL := all
-.DELETE_ON_ERROR:
-.SUFFIXES:
+pages   := $(shell find . -type f -name '*.adoc')
+out_dir := ./_public
 
-ANTORA_PREVIEW_CMD ?= $(DOCKER_CMD) run --rm --publish 35729:35729 --publish 2020:2020 --volume "${PWD}":/preview/antora vshn/antora-preview:3.0.1.1 --style=syn --antora=docs
+docker_cmd  ?= docker
+docker_opts ?= --rm --tty --user "$$(id -u)"
 
-DOCKER_CMD  ?= docker
-DOCKER_ARGS ?= run --rm --user "$$(id -u)" --volume "$${PWD}:/src" --workdir /src
-
-YAML_FILES      ?= $(shell find . -type f -name '*.yaml' -or -name '*.yml')
-YAMLLINT_ARGS   ?= --no-warnings
-YAMLLINT_CONFIG ?= .yamllint.yml
-YAMLLINT_IMAGE  ?= docker.io/cytopia/yamllint:latest
-YAMLLINT_DOCKER ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(YAMLLINT_IMAGE)
-
-VALE_CMD  ?= $(DOCKER_CMD) $(DOCKER_ARGS) --volume "$${PWD}"/docs/modules:/pages vshn/vale:2.1.1
-VALE_ARGS ?= --minAlertLevel=error --config=/pages/ROOT/pages/.vale.ini /pages
+vale_cmd ?= $(docker_cmd) run $(docker_opts) --volume "$${PWD}"/docs/modules/ROOT/pages:/pages --workdir /pages docker.io/vshn/vale:2.10.5.1 --minAlertLevel=error /pages
+preview_cmd ?= $(docker_cmd) run --rm --publish 35729:35729 --publish 2020:2020 --volume "${PWD}":/preview/antora docker.io/vshn/antora-preview:3.1.1.1 --antora=docs --style=syn
 
 .PHONY: all
-all: lint docs open
-
-.PHONY: lint
-lint: lint_yaml docs-vale
+all: html
 
-.PHONY: lint_yaml
-lint_yaml: $(YAML_FILES)
-	$(YAMLLINT_DOCKER) -f parsable -c $(YAMLLINT_CONFIG) $(YAMLLINT_ARGS) -- $?
+# This will clean the Antora Artifacts, not the npm artifacts
+.PHONY: clean
+clean:
+	rm -rf $(out_dir) '?' .cache
 
-.PHONY: docs-serve
-docs-serve:
-	$(ANTORA_PREVIEW_CMD)
+.PHONY: check
+check:
+	$(vale_cmd)
 
-.PHONY: docs-vale
-docs-vale:
-	$(VALE_CMD) $(VALE_ARGS)
+.PHONY: preview
+preview:
+	$(preview_cmd)

README.md

@@ -1,12 +1,13 @@
 # Project Syn Documentation
 
-This is the umbrella documentation for project syn.
-It is written using [Asciidoc][asciidoc] and [Antora][antora] and located in the [docs/](docs) folder.
+This is the umbrella documentation for Project Syn.
+
+It is written using [AsciiDoc][asciidoc] and [Antora][antora]. The source is located in the [docs/](docs) folder.
 The [Divio documentation structure](https://documentation.divio.com/) is used to organize its content.
 
-Run the `make docs-serve` command in the root of the project, and then browse to http://localhost:2020 to see a preview of the documentation.
+Run the `make preview` command in the root of the project, and then browse to http://localhost:2020 to see a preview of the documentation.
 
-After writing the documentation, please use the `make docs-vale` command and correct any warnings raised by the tool.
+After writing the documentation, please use the `make check` command and correct any warnings raised by the tool.
 
 ## Contributing and license
 

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

@@ -3,7 +3,6 @@ MinAlertLevel = warning # suggestion, warning or error
 
 # Only check Asciidoc files
 [*.adoc]
-
-# Using the Microsoft style
 BasedOnStyles = Microsoft
-Microsoft.GenderBias = warning
+Microsoft.GenderBias = suggestion
+Openly.GenderBias = suggestion

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

@@ -4,84 +4,41 @@ This page lists the high level roadmap of Project Syn. It will be under constant
 
 > It's done when it's done
 
-== v0.1.0
+NOTE: We release the tools independently, this page contains a list of ideas throughout all Project Syn tools.
 
-*Released*: 2020–03–02
+== Planned
 
-This is the very first release of Project Syn and contains the following tool releases:
+Features which we're confident are being implemented:
 
-* https://github.com/projectsyn/lieutenant-operator/releases/tag/v0.1.0[Lieutenant Operator - v0.1.0]
-* https://github.com/projectsyn/lieutenant-api/releases/tag/v0.1.0[Lieutenant API - v0.1.0]
-* https://github.com/projectsyn/commodore/releases/v0.1.0[Commodore - v0.1.0]
-* https://github.com/projectsyn/steward/releases/tag/v0.1.0[Steward - v0.1.0]
+Commodore::
+* Make catalog compilation much faster than it's today (Rewrite Reclass in Rust).
+* Introduce component dependency handling.
+* Rework UX of CLI.
+* Support for decentralized GitOps repositories.
+* Create merge requests on catalog generation (policy-based, similar to Renovate).
+* Local development environment for simpler Commodore Component development.
 
-With this initial release the focus was to get the basics up and running:
+Lieutenant::
+* Remove Lieutenant API and make it a 100% Kubernetes API.
+* Component version reporting, so that it's known which Component versions are used where.
 
-* Registering Tenants and Clusters in Lieutenant
-* Bootstrap GitOps repositories
-* Bootstrap Steward and GitOps on the Cluster
-* Generate Cluster Catalogs with Commodore
+== Vision
 
-Announcement blog post: https://vshn.ch/en/blog/first-pre-release-of-project-syn-tools/[First Pre-Release of Project Syn Tools].
+Features which are part of our vision and therefore have uncertainty of being implemented:
 
-== v0.2.0
-
-*Released*: 2020–07–23
-
-This is the second release of Project Syn and contains the following tool releases:
-
-* https://github.com/projectsyn/lieutenant-operator/releases/tag/v0.2.0[Lieutenant Operator - v0.2.0]
-* https://github.com/projectsyn/lieutenant-api/releases/tag/v0.2.0[Lieutenant API - v0.2.0]
-* https://github.com/projectsyn/commodore/releases/v0.2.0[Commodore - v0.2.0]
-* https://github.com/projectsyn/steward/releases/tag/v0.2.0[Steward - v0.2.0]
-* https://github.com/orgs/projectsyn/projects/1[GitHub Project]
-
-Focus for this release:
-
-* Enable people to work with Commodore Components (CC), "Dev Experience."
-** Helper tools to write Commodore Components (https://cookiecutter.readthedocs.io[Cookiecutter] template)
-* Decommissioning of clusters and other components fully automated
-** Git repository deletion mechanism - including safe-guards
-* Get the bootstrap process fully automated
-** Automate creation of cluster config file in tenant configuration repository
-** Initialize empty catalog Git repository
-* Bring the documentation of Project Syn up to speed
-** Rework existing Syn Design Documents
-** How-Tos for basic workflows
-
-Announcement blog post: https://vshn.ch/blog/second-beta-release-of-project-syn-tools/[Second Beta Release of Project Syn Tools].
-
-== v1.0.0
-
-The following topics will be part of the first one-point-zero release:
-
-* Enhancements for Commodore Component developers
-** Component testing framework and automation
-** Component documentation automation and integration into syn.tools
-* Enhanced Commodore configuration hierarchy (dynamic hierarchy)
-* Automated Component maintenance with Renovate (Support for GitHub)
-* Automated secret generation in Vault on cluster creation
-* Implementation of https://syn.tools/syn/SDDs/0023-managed-services-controller.html[SDD 0023 - Managed Services Controller]
-* GitOps for application deployment on a Project Syn enabled Kubernetes Cluster
-* Commodore automated catalog generation
-** Implementation of https://syn.tools/syn/SDDs/0021-cluster-catalog-compilation.html[SDD 0021 - Cluster Catalog Compilation]
-
-New tools appearing in this release:
-
-* _Quartermaster_: Catalog compilation decision engine
-* _Carpenter_: Conditional object generator
-
-https://github.com/orgs/projectsyn/projects/2[GitHub Project]
+* Project Syn Control Plane as a Service (So you don't have to care of running Lieutenant, Vault and other stuff needed).
+* Renewed "Getting Started" experience to make it much easier to start with Project Syn.
+* Decentralized catalog compilation, for example directly on the destination cluster.
+* Make Commodore Components usable standalone, without requiring Lieutenant and Steward.
+* Automated secret generation in Vault on cluster creation.
+* Support for other Git repository hosting than GitLab (for example GitHub, Gitea, Forgejo)
+* Git commit signing of Commodore catalogs and only allow properly signed catalogs on clusters
 
-== Upcoming
+== Older Releases
 
-NOTE: This is still subject to change
+See the GitHub Releases for each tool:
 
-* Enhance Commodore to be used for regular application deployment
-* Full https://crossplane.io/[Crossplane] integration
-* Enable Commodore to create merge requests on catalog generation (policy-based, similar to Renovate)
-* Integration of Open Policy Agent into Lieutenant Operator
-* Git commit signing of Commodore catalogs and only allow properly signed catalogs on clusters
-* Automated cluster provisioning object generator, supporting OpenShift Hive and Crossplane
-* Cluster inventory enhancements (reports via Lieutenant inventory)
-* Pull / Merge Request dashboard showing open maintenance requests
+* https://github.com/projectsyn/commodore/releases[Commodore^]
+* https://github.com/projectsyn/lieutenant-operator/releases[Lieutenant Operator^]
+* https://github.com/projectsyn/lieutenant-api/releases[Lieutenant API^]
+* https://github.com/projectsyn/steward/releases[Steward^]

docs/modules/ROOT/pages/references/style-guide.adoc

@@ -390,7 +390,7 @@ animal.newAnimal("Finnegan",
 ==== File structure
 
 * Jsonnet files which are intended to be materialized should end with the `.jsonnet` suffix.
-* Jsonnet files which aren't intended to be materialized -- usually libraries -- should end with the `.libjsonnet` suffix.
+* Jsonnet files which aren't intended to be materialized (usually libraries) should end with the `.libjsonnet` suffix.
 * Files in `lib` always are libraries which should never be materialized and must be named accordingly.
   Those files are considered part of a public API.
   Treat functions in libraries accordingly and look out for breaking changes.