search

minrk / nbstencilaproxy

Jupyter+DAR compatibility exploration
BSD 3-Clause "New" or "Revised" License
12 stars 6 forks source link

Add a landing page listing all Dar documents/projects in the archive folder #6

Open nuest opened 6 years ago

nuest commented 6 years ago

AFAIC the dar-server does not have a "list me all Dar projects in the storage" function, but something like that would be needed for an index page.

@nokome: Does some other component provide this functionality?

nokome commented 6 years ago

Good point. I'm not too familiar with dar-server that's a question for @michael or @oliver----

obuchtala commented 6 years ago

@nuest There is nothing like this yet. You can use html params for that. See for example https://github.com/stencila/stencila/blob/develop/app/index.html darServer has some arguments to control which folder is used as root folder for archives: https://github.com/substance/dar-server/blob/master/src/serve.js#L10-L15

nuest commented 6 years ago

@oliver---- Thanks for clarifying. HTML params require us to know the name of the Dar directory beforehand, which we do not. Maybe to clarify what we want:

A user has one (or more) Dar directories in a repository on GitHub. When she opens the repo with binder, we would like to open Stencila with either the only Dar, or show a list of available ones.

As of now, the user has to provide the directory name. It would be cool if she does not have to.

(Also, we assume that a Dar will always be a directory. Will read the spec later today ;-) )

obuchtala commented 6 years ago

(moved to gitter for more discussions)

nuest commented 6 years ago

@oliver---- @nokome @michael I think it would be great if we can "wrap up" the integration done at eLife Sprint during the next couple of weeks. Do you think this issue (a landing page) should be included? I don't know how it relates to the other ideas for integrations mentioned on Gitter, so your input would be useful.

@oliver---- AFAIR you made some change to dar-server supporting this - are those already released?

nokome commented 6 years ago

I think the conclusion was just to keep it a single Dar for now i.e. no landing page at least for now.

michael commented 6 years ago

Would stick with a single Dar for now too. The listArchives API is there in DarServer, but no need to use it.