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 neuroblueprint blog. #96

Merged
merged 10 commits into from
May 2, 2024
Merged

Add neuroblueprint blog. #96

merged 10 commits into from
May 2, 2024

Conversation

JoeZiminski
Copy link
Member

@JoeZiminski JoeZiminski commented Apr 25, 2024

This blog gives motivation for and introduction to NeuroBlueprint. It is the first of two related blog-posts introducing NeuroBlueprint/ datashuttle.

It's aims are to:

  • Motivate the need for NeuroBlueprint / convince researchers of the benefits of standardisation
  • Give a breif introduction to the schema and how it slots into existing initiatives
  • Makes it easy for people to take the next steps towards using NeuroBlueprint

We (myself and Niko) are not strongly tied to any particular part of the existing draft so as much feedback as possible would be great. This is first real outreach on NeuroBlueprint so important to get this right to convince those at the SWC this is an endevour worth pursuing.

The docs can be built in the usual way:

  1. clone the repo, cd to the docs folder
  2. pip install -r requirements.txt
  3. sphinx-build source build
  4. Open the index.html page in the build directory, nagivate to 'Blog' and select this blog post

@JoeZiminski JoeZiminski changed the title Add first draft. Add neuroblueprint blog. Apr 25, 2024
@JoeZiminski JoeZiminski force-pushed the add-neuroblueprint-blog branch from bd1bb1c to 72e52e5 Compare April 25, 2024 10:57
@JoeZiminski JoeZiminski requested a review from a team April 25, 2024 12:00
@JoeZiminski JoeZiminski marked this pull request as ready for review April 25, 2024 12:04
Copy link
Member

@alessandrofelder alessandrofelder left a comment

Choose a reason for hiding this comment

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

Nice - very clear 👏
Found 1 typo (I think)

docs/source/blog/neuroblueprint.md Show resolved Hide resolved
docs/source/blog/neuroblueprint.md Outdated Show resolved Hide resolved
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.

Very nice. I've left a few small comments. A general comment about the blog, when I render it, the new blog is on the bottom. It should be in reverse chronological order, with new posts at the top. I think the brainglobe blog has this, so there may be some config to copy.

Also, the author doesn't show up in the blog summary for some reason (it does for @lauraporta's older post).

Lastly, it's pretty long (and with more to come!). I didn't see any obvious sections to cut, but while edits are being made, it would be good to see if there are any ways of making it a bit more concise.

docs/source/blog/neuroblueprint.md Outdated Show resolved Hide resolved
docs/source/blog/neuroblueprint.md Outdated Show resolved Hide resolved
docs/source/blog/neuroblueprint.md Outdated Show resolved Hide resolved
docs/source/blog/neuroblueprint.md Outdated Show resolved Hide resolved
docs/source/blog/neuroblueprint.md Outdated Show resolved Hide resolved
docs/source/blog/neuroblueprint.md Show resolved Hide resolved
docs/source/blog/neuroblueprint.md Show resolved Hide resolved
docs/source/blog/neuroblueprint.md Show resolved Hide resolved
docs/source/blog/neuroblueprint.md Show resolved Hide resolved
@JoeZiminski JoeZiminski linked an issue Apr 29, 2024 that may be closed by this pull request
@JoeZiminski
Copy link
Member Author

BTW @adamltyson the index order issue has been resolved by adding dates, would you mind re-building and checking this also
resolves #83?

@adamltyson
Copy link
Member

@JoeZiminski yep, the dates look fine. It just needs the date of this blog updating, and the author adding.

@JoeZiminski
Copy link
Member Author

JoeZiminski commented Apr 29, 2024

@JoeZiminski yep, the dates look fine. It just needs the date of this blog updating, and the author adding.

Okay great, at present Laura's name appears as it is the first line under the title in the blog page. The blog index then displays this as an 'excerpt'. Alternatively we can show the authors autoformatted by ABlog and have a different excerpt that is more like a subtitle.

Happy to include authors in the 'excerpt' position or instead autoformat the names in the index title and use the excerpt as a subtitle (we can ask @lauraporta for one for the MATLAB page). I think I have a slight preference for including the name autoformatted by ABlog and writing a custom excerpt.

image

@JoeZiminski JoeZiminski mentioned this pull request Apr 29, 2024
@adamltyson
Copy link
Member

@JoeZiminski yep, the dates look fine. It just needs the date of this blog updating, and the author adding.

Okay great, at present Laura's name appears as it is the first line under the title in the blog page. The blog index then displays this as an 'excerpt'. Alternatively we can show the authors autoformatted by ABlog and have a different excerpt that is more like a subtitle.

Happy to include authors in the 'excerpt' position or instead autoformat the names in the index title and use the excerpt as a subtitle (we can ask @lauraporta for one for the MATLAB page). I think I have a slight preference for including the name autoformatted by ABlog and writing a custom excerpt.

image

I vote for the Ablog style (as it links to other posts by the author too), and ask @lauraporta nicely for an excerpt.

@JoeZiminski
Copy link
Member Author

@lauraporta has kindly agreed to supply a subtitle, will add in new PR after this is merged. Will do a final readthrough of this tomorrow and merge!

@lauraporta
Copy link
Member

Sorry for missing this thread.|
I'm happy to readapt the MATLAB blogpost to include a subtitle, and as @JoeZiminski said, I'll open a PR to correct it after this one is merged.

@JoeZiminski
Copy link
Member Author

Hey @niksirbi I could not get control of the author order, it is interchanging randomly I think for this reason. As a workaround we could set the author as 'Niko Sirmpilatze & Joe Ziminski' and vice-versa for the datashuttle blog. The only problem with this is it treats this as a single name for lookups, and so clicking the name on the index will take you to an author 'Niko Sirmpilatze & Joe Ziminski' which is not the same as 'Joe Ziminski & Niko Sirmpilatze '. Maybe this is a sufficient workaround for the time being.

@JoeZiminski
Copy link
Member Author

@niksirbi this is fixed now good to go!

@niksirbi
Copy link
Member

niksirbi commented May 2, 2024

Wow thanks for opening and fixing the issue upstream @JoeZiminski !

@JoeZiminski JoeZiminski merged commit 01739c6 into main May 2, 2024
3 checks passed
@adamltyson adamltyson deleted the add-neuroblueprint-blog branch May 2, 2024 15:35
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.

Add dates for blog entries
5 participants