Skip to content

Commit

Permalink
doc: known issues: Won't Fix filtering
Browse files Browse the repository at this point in the history
Changed the version filter on the known issues page to use the
dynamic filter directive instead, and added a "Won't fix" filter
as well.

Signed-off-by: Gaute Svanes Lunde <gaute.lunde@nordicsemi.no>
  • Loading branch information
gautesl authored and carlescufi committed Oct 6, 2023
1 parent d4e8dd5 commit 3d61df2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 149 deletions.
98 changes: 0 additions & 98 deletions doc/nrf/includes/filter.js

This file was deleted.

63 changes: 12 additions & 51 deletions doc/nrf/releases_and_maturity/known_issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,65 +21,26 @@ A known issue can list one or both of the following entries:
Some known issues have a workaround.
Sometimes, they are discovered later and added over time.

.. raw:: html
:file: ../includes/filter.js

.. raw:: html

Filter by versions:

<select name="versions" id="versions-select">
<option value="all">All versions</option>
<option value="v2-4-2" selected>v2.4.2</option>
<option value="v2-4-1">v2.4.1</option>
<option value="v2-4-0">v2.4.0</option>
<option value="v2-3-0">v2.3.0</option>
<option value="v2-2-0">v2.2.0</option>
<option value="v2-1-4">v2.1.4</option>
<option value="v2-1-3">v2.1.3</option>
<option value="v2-1-2">v2.1.2</option>
<option value="v2-1-1">v2.1.1</option>
<option value="v2-1-0">v2.1.0</option>
<option value="v2-0-2">v2.0.2</option>
<option value="v2-0-1">v2.0.1</option>
<option value="v2-0-0">v2.0.0</option>
<option value="v1-9-2">v1.9.2</option>
<option value="v1-9-1">v1.9.1</option>
<option value="v1-9-0">v1.9.0</option>
<option value="v1-8-0">v1.8.0</option>
<option value="v1-7-1">v1.7.1</option>
<option value="v1-7-0">v1.7.0</option>
<option value="v1-6-1">v1.6.1</option>
<option value="v1-6-0">v1.6.0</option>
<option value="v1-5-2">v1.5.2</option>
<option value="v1-5-1">v1.5.1</option>
<option value="v1-5-0">v1.5.0</option>
<option value="v1-4-2">v1.4.2</option>
<option value="v1-4-1">v1.4.1</option>
<option value="v1-4-0">v1.4.0</option>
<option value="v1-3-2">v1.3.2</option>
<option value="v1-3-1">v1.3.1</option>
<option value="v1-3-0">v1.3.0</option>
<option value="v1-2-1">v1.2.1</option>
<option value="v1-2-0">v1.2.0</option>
<option value="v1-1-0">v1.1.0</option>
<option value="v1-0-0">v1.0.0</option>
<option value="v0-4-0">v0.4.0</option>
<option value="v0-3-0">v0.3.0</option>
</select>

..
.. version-filter::
:default: v2-4-2
:container: dl/dt
:tags: [("wontfix", "Won't fix")]

.. page-filter::
:name: issues

wontfix Won't fix

.. HOWTO
When adding a new version, add it to the dropdown list above and move the "selected" option next to it.
Once "selected" is moved, only issues that are valid for the new version will be displayed when entering the page.
When adding a new version, set it as the default value of the version-filter directive.
Once the version is updated, only issues that are valid for the new version will be displayed when entering the page.
Known issues process is described at https://nordicsemi.atlassian.net/wiki/spaces/NCS/pages/108237688/Known+Issues+process
When updating this file, add entries in the following format:
.. rst-class:: vXXX vYYY
.. rst-class:: wontfix vXXX vYYY
JIRA-XXXX: Title of the issue (with mandatory JIRA issue number since nRF Connect SDK v1.7.0)
Description of the issue.
Expand Down

0 comments on commit 3d61df2

Please sign in to comment.