Merge branch 'release/2.7.1'

developer-docs/release-procedures.md

@@ -11,7 +11,6 @@ Before any release is performed, documentation should first be updated for any c
 * Additions or updates to core documentation related to any new features or changes.
 * Addition of release notes for the release. This should be added to the [project-docs/release-notes](../project-docs/release-notes) directory.
 * Link the release notes into the documentation table of contents. This should be added to [project-docs/index.rst](../project-docs/index.rst).
-* Update the notice for the current released version of Educates. This should be added to [project-docs/project-details/project-overview.md](../project-docs/project-details/project-overview.md).
 
 Where changes are non trivial or need further explanation, the release notes should include a cross reference to other parts of the documentation describing the feature.
 

project-docs/index.rst

@@ -8,6 +8,7 @@ Educates
   :caption: Project Details:
 
   project-details/project-overview
+  project-details/project-roadmap
   project-details/sample-screenshots
 
 .. toctree::

project-docs/project-details/project-overview.md

@@ -5,18 +5,20 @@ The Educates project is designed to provide a platform for hosting workshops. It
 
 Although the principal deployment platform for Educates is Kubernetes, and is being used to teach users about Kubernetes, it could also be used to host training for other purposes as well. It may for example be used to help train users in web based applications, use of databases, or programming languages, where the user has no interest or need for Kubernetes.
 
-Latest project version
-----------------------
-
-The latest release of Educates is version 2.7.0.
-
 Source code repositories
 ------------------------
 
 The source code repository for the Educates training platform can be found at:
 
 * [https://github.com/vmware-tanzu-labs/educates-training-platform](https://github.com/vmware-tanzu-labs/educates-training-platform)
 
+Latest project release
+----------------------
+
+To determine what is the most recent released version of Educates, see:
+
+* [https://github.com/vmware-tanzu-labs/educates-training-platform/releases/latest](https://github.com/vmware-tanzu-labs/educates-training-platform/releases/latest)
+
 Getting help with Educates
 --------------------------
 

project-docs/project-details/project-roadmap.md

@@ -0,0 +1,70 @@
+Project Roadmap
+===============
+
+For long term project plans see the [project
+roadmap](https://github.com/vmware-tanzu-labs/educates-training-platform/blob/develop/developer-docs/project-roadmap.md)
+included in the project source code.
+
+Details of more immediate plans are listed below.
+
+(upcoming-changes)=
+Upcoming changes
+----------------
+
+Note that the following features are deprecated and the current plan is that
+they will be removed sometime in the 3.X series of Educates releases:
+
+* The classic renderer for workshop instructions (Markdown and AsciiDoc) will be
+  removed. All workshops should be ported over to use the Hugo (Markdown) based
+  renderer.
+
+* The older mechanism for downloading workshop files by specifying
+  `spec.content.files` in the workshop definition will be removed. The `vendir`
+  based mechanism for workshop files should be used instead.
+
+* The Octant web console for viewing and interacting with a Kubernetes cluster
+  will be removed. The standard Kubernetes dashboard should be used instead.
+
+* The use of `profile.d` files has been supersed by adding environment variables
+  to the `WORKSHOP_ENV` file from `setup.d` scripts. Support for `profile.d`
+  files will be removed to more easily allow the set of shell scripts used to
+  initialize a workshop container to be re-implemented as a standalone Go
+  application. Workshops should switch to setting environment variables from
+  `setup.d` scripts.
+
+* Support for deploying Educates to a Kubernetes cluster which uses Pod Security
+  Policies will be removed.
+
+* Supply of Carvel repository packages for Educates will be stopped. You will
+  still be able to install Educates using Carvel packages using supplied `App`
+  resource definitions, but the `PackageRepository` resource type which bundles
+  access to multiple versions will go away. This is being done because in-place
+  rolling updates of the Educates version isn't always feasible and it is always
+  recommended to install from scratch rather than upgrading.
+
+* The `skaffold` command line tool will be removed. If this is required for a
+  specific workshop it will need to install it as part of workshop setup.
+
+* The `buildah` command line tool has been included for some time but is
+  believed to be non functional due to limitations in most Kubernetes
+  environments. If this is confirmed it will be removed.
+
+* The name of the workshop session UNIX user will be changed from `eduk8s` to a
+  name not linked to the project name. Workshops should use `~/` or `$HOME/` in
+  file system paths where possible, but may need to change paths where anchors
+  for home directory cannot be used.
+
+Other notable changes intended to be made with version 3.X of Educates are:
+
+* The ability of the `educates` CLI to install Educates and also create a local
+  Kind Kubernetes cluster for hosting Educates is being overhauled. The
+  experience will be similar, but the requirement for `kapp-controller` to exist
+  in the Kubernetes cluster is being removed. The `kapp-controller` package
+  will still be able to be optionally installed as it may still be required by
+  workshops that depend on it. The CLI will also support opinionated installs
+  of Educates to IaaS providers such as AWS, GCP and Azure.
+
+* First class support for OpenShift will be added back into Educates after
+  having previously been removed. This will include support for using the
+  OpenShift web console embedded as a dashboard tab, and RBAC for commonly
+  used OpenShift specific namespaced resources.

project-docs/release-notes/version-2.7.1.md

@@ -1,6 +1,13 @@
 Version 2.7.1
 =============
 
+Upcoming Changes
+----------------
+
+For details on significant changes in future versions, including feature
+deprecations and removals which may necessitate updates to existing workshops,
+see [Upcoming changes](upcoming-changes).
+
 New Features
 ------------