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 'Community' section. #58

Merged
merged 16 commits into from
May 30, 2024
Merged

Add 'Community' section. #58

merged 16 commits into from
May 30, 2024

Conversation

JoeZiminski
Copy link
Member

@JoeZiminski JoeZiminski commented May 16, 2024

This PR adds a community section giving some contact details of NIU (and general standardisation community). It also adds a N.B specific roadmap. This is currently a draft PR to support other discussions on roadmaps (e.g. here).

TODO:
The datashuttle website has the 'guiding principles' that the NB roadmap should link to. Also the datashuttle and NB roadmaps should link to eachother. For now I have linked here to what the datashuttle link is expected to be. I think the non-real link will result in build error. Once datashuttle community section is merged, we can then publish this. Then we can go back and do a quick release to add datashuttle links to NB? Maybe there is a better way to link related projects with sphinx.

@JoeZiminski JoeZiminski marked this pull request as draft May 16, 2024 18:23
docs/source/community.md Show resolved Hide resolved
docs/source/roadmap.md Outdated Show resolved Hide resolved
docs/source/roadmap.md Outdated Show resolved Hide resolved
docs/source/roadmap.md Outdated Show resolved Hide resolved
docs/source/roadmap.md Outdated Show resolved Hide resolved
docs/source/roadmap.md Show resolved Hide resolved
@JoeZiminski JoeZiminski requested a review from niksirbi May 17, 2024 10:23
Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

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

LGTM. My only suggestion is that it looks slightly weird to have a roadmap with only milestone in it. Is there anything to add for 2025?

@JoeZiminski
Copy link
Member Author

JoeZiminski commented May 17, 2024

Some things we could add might be:

  • incorporate BIDS suffixes to help distinguish between acquisition methods of the same datatype (e.g. fusi vs. 2p)
  • We could add other required metadata or analysis purposes. For example we current aim to standardised sync timings for multimodal analysis. In future I guess we we are also interested in other types of multimodal analysis (e.g. tracking ephys probes). So we'll have to add in some required metadata keys for this. That could be another aim (+ adding in required metadata keys for other analyses we might like to automate)?

To get this moving I will remove the links to datashuttle roadmap so we can merge. Then datashuttle will be able to link to this page without issue. It will be good to get @niksirbi but I don't think he'd mind us merging now and we can add on additional changes soon.

@JoeZiminski
Copy link
Member Author

Apologies @niksirbi I just realised I never set this 'Ready for Review', please let me know if you disagree with anything!

@niksirbi
Copy link
Member

I'll try to have a look at this next week.

Copy link
Member

@niksirbi niksirbi left a comment

Choose a reason for hiding this comment

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

Actually I realised it's quite a small PR, so reviewed it right away. I just have a few nitpicky comments about language.

docs/source/community.md Outdated Show resolved Hide resolved
docs/source/roadmap.md Outdated Show resolved Hide resolved
docs/source/roadmap.md Show resolved Hide resolved
JoeZiminski and others added 3 commits May 30, 2024 17:31
@JoeZiminski JoeZiminski merged commit 4f5c3f1 into main May 30, 2024
3 checks passed
@JoeZiminski JoeZiminski deleted the add_community_section branch May 30, 2024 16:40
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.

3 participants