From 8c8094e3314546b9a8d2da49bcba63d1b985ccdf Mon Sep 17 00:00:00 2001 From: Oliver Ruebel Date: Tue, 27 Aug 2024 01:44:32 -0700 Subject: [PATCH] Restructure the NWBEP page --- docs/source/extensions.rst | 81 +++++++++++++++++++++----------------- docs/source/index.rst | 2 +- 2 files changed, 45 insertions(+), 38 deletions(-) diff --git a/docs/source/extensions.rst b/docs/source/extensions.rst index b377bfa..4f7aa95 100644 --- a/docs/source/extensions.rst +++ b/docs/source/extensions.rst @@ -1,66 +1,73 @@ .. _extensions-catalog: -******************************** -Extensions Catalog and Proposals -******************************** - -NWB Extensions (NDX) Catalog -============================ - -The :ndx-catalog:`NDX Catalog website <>` contains published -extensions created by the community to add support for a wide variety of data types. -Before creating your own extension, we recommend that you explore the Catalog to -make sure that someone has not already created an extension that suits your needs -or that you could build off of. - -Policies on Community-driven Development and Integration of New Neuroscience Technologies with NWB --------------------------------------------------------------------------------------------------- - -- `Sharing Guidelines: requirements and strategy for sharing format extensions for NWB `_ -- `Sharing Strategies: standard practices and strategies for sharing format extensions for NWB `_ -- `Versioning Guidelines: requirements and strategy for versioning namespaces for the NWB core schema and extensions `_ - +********************************** NWB Enhancement Proposals (NWBEPs) -================================ +********************************** -The NWB data standard is not static but evolves to adapt to changing needs from the neuroscience community, +The NWB data standard is not static but evolves to adapt to changing needs from the neuroscience community, clarify ambiguities, and fix bugs, among others. Users can propose smaller changes, such as improvements to -documentation or addition of a new optional field to an existing data type, on the -:nwb-schema-src:`NWB Schema GitHub repository <>`. Users can propose larger changes, such as addition of -several new data types to support a new data modality, or a major restructuring of existing data types, -through NWB Enhancement Proposals (NWBEPs). +documentation or addition of a new optional field to an existing data type, on the +:nwb-schema-src:`NWB Schema GitHub repository <>`. Users can propose larger changes, such as addition of +several new data types to support a new data modality, or a major restructuring of existing data types, +through NWB Enhancement Proposals (NWBEPs). NWBEPs are often collaborative and led by members of +the community to address a significant need by the +community. + +.. note:: -NWBEPs are often collaborative and led by members of the community to address a significant need by the -community. Here is a list of NWBEPs that have been started: + The :ndx-catalog:`NDX Catalog website <>` contains published + extensions created by the community. Before creating your own extension, + we recommend that you explore the Catalog to make sure that someone has + not already created an extension that suits your needs or that you could + build off of. Also see :ref:`extension-publishing-ndxcatalog` for details + on how to publish your own extension in the NDX Catalog. -.. list-table:: NWBEPs +Current NWBEPs +============== + +.. list-table:: **NWBEPs** :widths: 15 45 25 15 :header-rows: 1 - * - NBWEP + * - NWBEP - Title - Lead - URLs * - NWBEP001 - Events and TTL Data - Ryan Ly - - `Google Doc `_ + - `Google Doc `__ * - NWBEP002 - Probe devices and channel mapping in extracellular ephys - Alessio Buccino - - `Google Doc `_ + - `Google Doc `__ * - NWBEP003 - Multichannel volumetric imaging - Daniel Sprague - - `Google Doc `_ + - `Google Doc `__ + + +.. note:: + + To add a new NWBEP to this list, please file an issue on the :nwb-overview-src:`NWB Overview GitHub repo <>` + or create a pull request that modifies the table. + +Related Policies +================= +The following list shows NWB policies related to community-driven development and integration +of new neuroscience technologies with NWB + +- `Sharing Guidelines: requirements and strategy for sharing format extensions for NWB `_ +- `Sharing Strategies: standard practices and strategies for sharing format extensions for NWB `_ +- `Versioning Guidelines: requirements and strategy for versioning namespaces for the NWB core schema and extensions `_ -To add a new NWBEP to this list, please file an issue on the :nwb-overview-src:`NWB Overview GitHub repo <>` -or create a pull request that modifies the table. +NWBEP Submission and Review Process +=================================== -Review of NWBEPs for acceptance to the NWB core data standard is led by the +Review of NWBEPs for acceptance to the NWB core data standard is led by the :nwb-tab:`NWB Technical Advisory Board (TAB) <>` -and involves several phases. To submit a NWBEP for review and explore previous NWBEP reviews, see the +and involves several phases. To submit a NWBEP for review and explore previous NWBEP reviews, see the :nwbep-review:`NWBEP Review GitHub repo <>`. For more information on the NWBEP process, see the following links: - `Proposal Review Process: process by which extensions to the NWB core standard are proposed, evaluated, reviewed, and accepted `_ diff --git a/docs/source/index.rst b/docs/source/index.rst index b8d2b73..494b3fe 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -21,6 +21,7 @@ for each of those tasks and point you to the best tools to use for your preferre conversion_tutorial/user_guide file_read/file_read extensions_tutorial/extensions_tutorial_home + extensions core_tools/core_tools_home .. toctree:: @@ -34,7 +35,6 @@ for each of those tasks and point you to the best tools to use for your preferre :maxdepth: 1 community_gallery/community_gallery.rst - extensions faq .. toctree::