Merge pull request #666 from nsidc/docs-plugin-deprecation

Update docs, add admonitions to deprecate QGreenland Custom
nsidc · Jul 7, 2023 · 48c65d7 · 48c65d7
2 parents 0179f22 + 9c2e9a4
commit 48c65d7
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 48 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # NEXT_RELEASE
 
-* Remove "Biology/Fish/Arctic Char" layer
+* QGreenland Custom is no longer supported.
+* Remove "Biology/Fish/Arctic Char" layer.
 
 
 # v3.0.0alpha3 (2023-07-05)

diff --git a/doc/contributor-how-to/how-to-dev-plugin.md b/doc/contributor-how-to/how-to-dev-plugin.md
diff --git a/doc/reference/glossary/user-glossary.md b/doc/reference/glossary/user-glossary.md
@@ -11,6 +11,10 @@ disciplines within a reasonable file size.
 
 ## QGreenland Custom
 
+```{attention}
+QGreenland Custom is no longer supported.
+```
+
 QGreenland Custom is a QGIS plugin that enables users to download and use only
 the QGreenland layers they are interested in.
 

diff --git a/doc/tutorials/plugin-how-to.md b/doc/tutorials/plugin-how-to.md
@@ -1,5 +1,9 @@
 # Install and use QGreenland Custom
 
+```{attention}
+QGreenland Custom is no longer supported.
+```
+
 For a full tutorial on how to install and use the QGreenland QGIS plugin, 
 QGreenland Custom, visit the QGreenland Custom documentation 
 [here](https://qgreenland-plugin.readthedocs.io/en/latest/user-how-to/plugin-how-to.html).
diff --git a/doc/user-how-to/metadata.md b/doc/user-how-to/metadata.md
@@ -27,6 +27,10 @@ that is associate with the data layer, including but not limited to title and ab
 
 ## Using the QGreenland Custom plugin
 
+```{attention}
+QGreenland Custom is no longer supported.
+```
+
 If you have the QGreenland Custom QGIS plugin, you can access QGreenland layer metadata through the plugin.
 First you will need download the layer of interest if you do not already have it downloaded. If you need help installing or downloading data using QGreenland Custom, please follow 
 [this how-to guide](https://qgreenland-plugin.readthedocs.io/en/latest/user-how-to/plugin-how-to.html) first. 

diff --git a/doc/what_is_qgr.md b/doc/what_is_qgr.md
@@ -15,6 +15,12 @@ delivered in two ways:
    (for example, due to filesize constraints). QGreenland Custom has its own
    [documentation](https://qgreenland-plugin.readthedocs.io).
 
+   ```{attention}
+   QGreenland Custom is no longer supported. This was an experiment, and we decided to
+   go in a different direction. It shouldn't be expected to work.
+   ```
+
+
 Return to [QGreenland website](https://qgreenland.org)
 
 # What QGreenland *is not*