Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic page on NWB extensions catalog and proposals #151

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

rly
Copy link
Contributor

@rly rly commented Mar 19, 2024

Moving some content from https://www.nwb.org/policies-overview/ here. Goal is to point users here (including from https://github.com/nwb-extensions/nep-review) to learn more about current draft NEPs.

@rly rly requested review from bendichter and oruebel March 19, 2024 23:25
@rly rly marked this pull request as ready for review March 19, 2024 23:25
docs/source/extensions.rst Outdated Show resolved Hide resolved
Comment on lines 35 to 51
.. list-table:: NEPs
:widths: 15 45 25 15
:header-rows: 1

* - NEP
- Title
- Lead
- URLs
* - NEP001
- Events and TTL Data
- Ryan Ly
- `Google Doc <https://docs.google.com/document/d/1qcsjyFVX9oI_746RdMoDdmQPu940s0YtDjb1en1Xtdw/edit?usp=sharing>`_
* - NEP002
- Probe devices and channel mapping in extracellular ephys
- Alessio Buccino
- `Google Doc <https://docs.google.com/document/d/1q-haFEEHEgZpRoCzzQsuSWCKN4QfMsTzLnlptLaf-yw/edit?usp=sharing>`_

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend maintaining this list of NEP's in one place, preferably the place where NEPs are being managed, i.e., either on the repo or the NDX Catalog. It'll be hard enough to maintain this list in one place. I would just point to the list here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I suggest this is the only place we maintain this list.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have single folder in GoogleDrive where each NEP would get a subfolder such that we could simply embed the folder listing?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is right place for this in the long run. I think something on nwb.org (once we have a new home) or on the NDX Catalog would be more appropriate.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting idea. Do you mean use an iframe here that points to a public Google Drive folder? Do you envision copying the google docs from the proposer's space to our folder or linking out to their google docs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think either way is fine. In general it seems simpler to just have the documents (with one subfolder ber NEP) in the Drive directly, but linking to the documents seems perfectly fine, as long as there is public read access on the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think something on nwb.org (once we have a new home) or on the NDX Catalog would be more appropriate.

I think new nwb.org would be a good home. I think linking to the docs is easy and fine.

docs/source/extensions.rst Outdated Show resolved Hide resolved
docs/source/extensions.rst Outdated Show resolved Hide resolved
Comment on lines +3 to +5
********************************
Extensions Catalog and Proposals
********************************
Copy link
Contributor

@oruebel oruebel Aug 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content of the page looks good, but I propose a few changes to the overall structure of the page (i.e., mainly just moving around some the content and changing section headings). Since these changes affect the whole page, it was tricky to propose these changes on the PR directly, so I created a separate PR that targets this PR to propose the changes #171 @rly please take a look at #171 and see what you think.

Copy link
Contributor

@oruebel oruebel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #171

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants