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

[MISC] moved list of extension proposals to the main BIDS website #389

Merged
merged 1 commit into from
Jan 15, 2020

Conversation

robertoostenveld
Copy link
Collaborator

The steering group identified that information about the bids community and style of working are scattered and there is not a clear starting point. This PR aims to consolidate information on the process of BEPs on the homepage and move it away from the technical specification itself.

The page 06-extensions.md remains (for now), but without the table, and simply points to the main website.

This also relates to #354, which proposed to add the Governance document to the specification. Rather than adding it to the specification on RTD, it should better be added to the homepage.

section 06-extensions remains, but now points to the main website
@effigies
Copy link
Collaborator

effigies commented Jan 7, 2020

👍 I agree with keeping the spec text as focused as possible, with some linking to the rest of the community.

Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

I agree with this proposal and what @effigies points out. Thanks @robertoostenveld

### The BIDS Starter Kit

If you're new to the BIDS community and you'd like to learn a bit more, we
recommend checking out the [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit/blob/master/README.md).
Copy link
Member

Choose a reason for hiding this comment

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

are you going to remove the BIDS Starter Kit dropdown menu as well?
image

On the website and in your updating PR (bids-standard/bids-website#77), I don't see a reference to the starter kit yet - perhaps it'd be good to add it somewhere.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The starter kit is already mentioned on the website under https://bids.neuroimaging.io/getting_started.html.

Although I did not make the initial section headings - just copied them - I suppose that "getting started" on the main website is more aimed towards users and "get involved" more at developers/contributors. The distinction between the two is ideally not very strict, since everyone would contribute one way or another to the BIDS ecosystem (with data, knowledge, insights, skills, technical effort, etc).

On the bids-specification site on RTD, the starter kit was not only mentioned on https://bids-specification.readthedocs.io/en/stable/06-extensions.html (even though the starter kit does not really deal with how to work on BEPs), but also still features in the top-level menu that appears on the left of the screen.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh, I now see your 1st question:

are you going to remove the BIDS Starter Kit dropdown menu as well?

If it is up to me, yes. But I think that should be a separate PR on both sides, so this PR keeps that as is. We first might want to improve the way how the Starter Kit is featured on the main website. And perhaps even reconsider the current Starter Kit implementation altogether.

Copy link
Member

Choose a reason for hiding this comment

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

Okay, that's a good way to move forward.

Copy link
Contributor

@melanieganz melanieganz left a comment

Choose a reason for hiding this comment

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

I also approve this change.

@sappelhoff sappelhoff merged commit 08cde6b into bids-standard:master Jan 15, 2020
@sappelhoff
Copy link
Member

Thanks @robertoostenveld

@yarikoptic
Copy link
Collaborator

Fwiw, and sorry that I came too late. My 1c: I liked being able to search in the spec for the term of interest (eg ASL) and be able to see that it is not just not yet supported but that there is a bep I could go to. In my view, moving beps references to the main website actually scatters information more instead of consolidating.

satra added a commit to satra/bids-specification that referenced this pull request Feb 7, 2020
* upstream/master: (439 commits)
  [DOC] Auto-generate changelog entry for PR bids-standard#394
  Update 01-contributors.md
  [DOC] Auto-generate changelog entry for PR bids-standard#389
  [DOC] Auto-generate changelog entry for PR bids-standard#386
  moved list of extension proposals to the main BIDS website section 06-extensions remains, but now points to the main website
  Typo fix for typo fix
  Typo fix for typo fix
  [DOC] Auto-generate changelog entry for PR bids-standard#374
  [FIX] Fix some typos and prose style issues
  [DOC] Auto-generate changelog entry for PR bids-standard#383
  restructure according to @emdupre's proposal
  neurostars for everything not just technical
  Apply suggestions from code review
  MNT: Update Pipfile
  ENH: Append CSS instead of overriding it
  ENH: Add watermark to drafts
  [DOC] Auto-generate changelog entry for PR bids-standard#381
  Update src/06-extensions.md
  Retiring moderator duties for BEP021
  [DOC] Auto-generate changelog entry for PR bids-standard#380
  ...
satra added a commit to satra/bids-specification that referenced this pull request Feb 7, 2020
* upstream/master: (439 commits)
  [DOC] Auto-generate changelog entry for PR bids-standard#394
  Update 01-contributors.md
  [DOC] Auto-generate changelog entry for PR bids-standard#389
  [DOC] Auto-generate changelog entry for PR bids-standard#386
  moved list of extension proposals to the main BIDS website section 06-extensions remains, but now points to the main website
  Typo fix for typo fix
  Typo fix for typo fix
  [DOC] Auto-generate changelog entry for PR bids-standard#374
  [FIX] Fix some typos and prose style issues
  [DOC] Auto-generate changelog entry for PR bids-standard#383
  restructure according to @emdupre's proposal
  neurostars for everything not just technical
  Apply suggestions from code review
  MNT: Update Pipfile
  ENH: Append CSS instead of overriding it
  ENH: Add watermark to drafts
  [DOC] Auto-generate changelog entry for PR bids-standard#381
  Update src/06-extensions.md
  Retiring moderator duties for BEP021
  [DOC] Auto-generate changelog entry for PR bids-standard#380
  ...
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.

6 participants