From de89aca49415cbc493560aaaca25f977c86cae11 Mon Sep 17 00:00:00 2001 From: Michael Schurter Date: Tue, 28 Sep 2021 11:11:19 -0700 Subject: [PATCH] docs: note demos/csi is unsupported Also start tagging authors to ease support by third parties. --- demo/csi/README.md | 5 +++++ demo/csi/hostpath/README.md | 2 ++ 2 files changed, 7 insertions(+) diff --git a/demo/csi/README.md b/demo/csi/README.md index 21680696b..6e7403f4c 100644 --- a/demo/csi/README.md +++ b/demo/csi/README.md @@ -3,6 +3,9 @@ This directory contains examples of registering CSI plugin jobs and volumes for those plugins. +Contributions are welcome but demos are *not supported* by the core Nomad +development team. Please tag demo authors when filing issues about CSI demos. + ### Contributing If you'd like to contribute an example, open a PR with a folder for the plugin @@ -10,5 +13,7 @@ in this directory. This folder should include: * A `README.md` with any added instructions a user might need to use the plugin. Please include a link to the CSI plugin's source repository. + * Add an `Author: @` field at the top so you can be tagged + on issues. * A Nomad job file for the plugin. * A [volume specification](https://www.nomadproject.io/docs/commands/volume/register#volume-specification) file. diff --git a/demo/csi/hostpath/README.md b/demo/csi/hostpath/README.md index 2534ddb08..076978a8e 100644 --- a/demo/csi/hostpath/README.md +++ b/demo/csi/hostpath/README.md @@ -1,5 +1,7 @@ # Hostpath CSI Plugin +Author: @hashicorp/nomad-eng + This directory includes a demo using the [CSI host path driver](https://github.com/kubernetes-csi/csi-driver-host-path) to create local "host path" volumes that can be mounted via the Nomad CSI