joss icon indicating copy to clipboard operation
joss copied to clipboard

Updating docs to include JOSE

Open tracykteal opened this issue 6 years ago • 8 comments

The Readthedocs is a great resource. It would be nice to add JOSE docs too. I can see a few ways to do this

  1. Update this documentation mainly around Reviewers, changing 'Review guidelines' to 'JOSS Reviewer guidelines' and then adding a 'JOSE Reviewer guidelines'. Likely also adding another template Editorial invite letter too.

  2. A different re-organization, basically with a JOSS section and a JOSE section. This could scale more easily to include other Open Journals. But then there might be a repeat in materials.

  3. Totally different docs for JOSS and JOSE. This would be clean, but then again would likely have some repeated materials.

Thoughts or other ideas? @labarba @arfon @Kevin-Mattheus-Moerman

tracykteal avatar Feb 04 '19 20:02 tracykteal

I think I would favour duplicate docs for JOSE (at https://jose.readthedocs.io)

arfon avatar Feb 04 '19 20:02 arfon

I agree with @arfon

danielskatz avatar Feb 04 '19 20:02 danielskatz

Looks like that domain is already taken.

labarba avatar Feb 04 '19 23:02 labarba

I think both JOSS and JOSE should configure custom domains; docs.joss.theoj.org or joss.docs.theoj.org would be fine.

https://docs.readthedocs.io/en/latest/custom_domains.html

jedbrown avatar Feb 04 '19 23:02 jedbrown

I think both JOSS and JOSE should configure custom domains; docs.joss.theoj.org or joss.docs.theoj.org would be fine.

Yep, we could do that.

arfon avatar Feb 05 '19 00:02 arfon

Both the separate docs and using those domains sounds good.

What would be the steps for setting up the domains?

We can move the docs from here over to the jose organization to get the docs started, and touch base with Kevin on how he's serving Readthedocs to set things up in the same way.

tracykteal avatar Feb 08 '19 21:02 tracykteal

What would be the steps for setting up the domains?

I can do this. You should start setting up the docs now and we can switch the domains out at the end.

We can move the docs from here over to the jose organization to get the docs started, and touch base with Kevin on how he's serving Readthedocs to set things up in the same way.

I'm actually set up all this stuff so you're already talking to the right person here :-)

Basically I would start by copying what you find in this folder into the JOSE application.

arfon avatar Feb 10 '19 12:02 arfon

Great, thanks. I'll submit an issue on JOSE to let them know I'm working on this, and put in a PR when I've done a first pass at updating to JOSE.

tracykteal avatar Feb 11 '19 23:02 tracykteal