Votable Issues (#4617)

* Create test2.yml * gha test * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * Update refresh-votable-issues.yml * initial * tidy * updated whatsnew * removed defunct ext links * Update docs/src/votable_issues.rst Co-authored-by: Ruth Comer <[email protected]> * added suggestion to subscribe to voted issues. * Renamed votable to voted. Layout tweaks to the voted issues page. Co-authored-by: Ruth Comer <[email protected]>
SciTools · Mar 10, 2022 · 6377594 · 6377594
1 parent 45f188b
commit 6377594
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 1 deletion.
diff --git a/docs/src/common_links.inc b/docs/src/common_links.inc
@@ -38,6 +38,7 @@
 .. _using git: https://docs.github.com/en/github/using-git
 .. _requirements/ci/: https://github.com/SciTools/iris/tree/main/requirements/ci
 .. _CF-UGRID: https://ugrid-conventions.github.io/ugrid-conventions/
+.. _issues on GitHub: https://github.com/SciTools/iris/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc
 
 
 .. comment

diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -302,6 +302,15 @@ def _dotv(version):
 html_static_path = ["_static"]
 html_style = "theme_override.css"
 
+# this allows for using datatables: https://datatables.net/
+html_css_files = [
+    "https://cdn.datatables.net/1.10.23/css/jquery.dataTables.min.css",
+]
+
+html_js_files = [
+    "https://cdn.datatables.net/1.10.23/js/jquery.dataTables.min.js",
+]
+
 # url link checker.  Some links work but report as broken, lets ignore them.
 # See https://www.sphinx-doc.org/en/1.2/config.html#options-for-the-linkcheck-builder
 linkcheck_ignore = [

diff --git a/docs/src/index.rst b/docs/src/index.rst
@@ -165,3 +165,4 @@ For **Iris 2.4** and earlier documentation please see the
    generated/api/iris
    techpapers/index
    copyright
+   voted_issues
diff --git a/docs/src/voted_issues.rst b/docs/src/voted_issues.rst
@@ -0,0 +1,55 @@
+.. include:: common_links.inc
+
+.. _voted_issues:
+
+Voted Issues
+============
+
+You can help us to prioritise development of new features by leaving a 👍
+reaction on the header (not subsequent comments) of any issue.
+
+.. tip:: We suggest you subscribe to the issue so you will be updated.
+         When viewing the issue there is a **Notifications**
+         section where you can select to subscribe.
+
+Below is a sorted table of all issues that have 1 or more 👍 from our github
+project.  Please note that there is more development activity than what is on
+the below table.
+
+.. _voted-issues.json: https://github.com/scitools/voted_issues/blob/main/voted-issues.json
+
+.. raw:: html
+
+   <table id="example" class="display" style="width:100%">
+      <thead>
+         <tr>
+            <th>👍</th>
+            <th>Issue</th>
+            <th>Author</th>
+            <th>Title</th>
+         </tr>
+      </thead>
+   </table>
+
+   <!-- JS to enable the datatable features: sortable, paging, search etc
+           https://datatables.net/reference/option/
+           https://datatables.net/  -->
+
+   <script type="text/javascript">
+        $(document).ready(function() {
+           $('#example').DataTable( {
+              <!-- "ajax": 'voted-issues.json', -->
+              "ajax": 'https://raw.githubusercontent.com/scitools/voted_issues/main/voted-issues.json',
+              "lengthMenu": [10, 25, 50, 100],
+              "pageLength": 10,
+              "order": [[ 0, "desc" ]]
+           } );
+        } );
+   </script>
+   <p></p>
+
+.. note:: The data in this table is updated daily and is sourced from
+          `voted-issues.json`_.
+          For the latest data please see the `issues on GitHub`_.
+          Note that the list on Github does not show the number of votes 👍
+          only the total number of comments for the whole issue.
diff --git a/docs/src/whatsnew/dev.rst b/docs/src/whatsnew/dev.rst
@@ -75,7 +75,8 @@ This document explains the changes made to Iris for this release
 📚 Documentation
 ================
 
-#. N/A
+#. `@tkknight`_ added a page to show the issues that have been voted for.  See
+   :ref:`voted_issues`. (:issue:`3307`, :pull:`4617`)
 
 
 💼 Internal