Should we require submissions to include index.html?

journalovi / jovi-template-quarto

JoVI experimental track article template written in Quarto

http://www.journalovi.org/jovi-template-quarto/

2 stars 8 forks source link

Should we require submissions to include index.html? #9

Open mjskay opened 1 year ago

mjskay commented 1 year ago

Currently, we require this, for several reasons:

We support non-quarto submissions; having a standard location of the actual paper makes it easier to support a range of document generators (including ones we can't run).
Having a compiled version gives us a comparison doc we can use to verify correctness of our own compilation.
Having a compiled version in the repo is better for long-term archiving, since one can (e.g.) use a service like Zenodo to get a long-term archived version of the main branch of the repo, including the rendered paper. Such archives are likely to last longer than our ability to run quarto.

Revisit after we have more experience with non-quarto papers when Info+ / VISxAI submissions come in. cc @domoritz

See also #7

mjskay commented 5 months ago

Requirements on this have evolved: the submission form now asks submitters to either have github pages set up (producing an index.html on the gh-pages branch) or, if it is not a compiled paper, to have index.html on the main branch.

I think for archiving purposes, we can let authors decide if they want index.html on the main branch or not, and we'll maybe want to archive both the main branch and the gh-pages branch.