Skip to content

provide link to online readthedocs specifications#36

Merged
chrisgorgo merged 1 commit intobids-standard:gh-pagesfrom
robertoostenveld:gh-pages
Jan 11, 2019
Merged

provide link to online readthedocs specifications#36
chrisgorgo merged 1 commit intobids-standard:gh-pagesfrom
robertoostenveld:gh-pages

Conversation

@robertoostenveld
Copy link
Copy Markdown
Collaborator

at the moment online version on readthedocs is not linked to, although it is much more accessible.

@chrisgorgo
Copy link
Copy Markdown

Thanks for bringing this up. We should wait until a release with adding such link. We want to show the latest release, but right now we only have the latest draft (which can change in a backward incompatible way). I'll try to make a minor release soon.

@robertoostenveld robertoostenveld changed the title provide link to readthedocs version of the specification provide link to online readthedocs specifications Jan 8, 2019
@robertoostenveld
Copy link
Copy Markdown
Collaborator Author

thanks for the quick reply. I was already unsure about versioning. Would indeed be nice if explicit versions can be use, like elsewhere on RTD.

Is there a plan of making previous versions also available in RTD? Right now I would say the draft is much improved over the previous versions in terms of structure and I realize that I have been seeing it as a continuously improving version. But that makes back porting the old versions more difficult.

Having explicit versions would require making a branch (or at least a tag), right?

I see that in the https://github.com/bids-standard/bids-website repository the following versions exist:

  • 0.4
  • 1.0.0
  • 1.0.1
  • 1.0.2
  • 1.1.0
  • 1.1.1

These all existed prior to the current version and are formatted as linear document. Do you still have those as google docs?

@chrisgorgo
Copy link
Copy Markdown

I have them as PDFs

@choldgraf would current setup you kindly put in place, provide links to individual versions as well as draft and latest?

@choldgraf
Copy link
Copy Markdown

I believe that we need to cut releases of the specification repo, then RTD will archive older versions of the docs

@chrisgorgo chrisgorgo merged commit 5b56887 into bids-standard:gh-pages Jan 11, 2019
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