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

Updating docs to include JOSE #491

Open
tracykteal opened this issue Feb 4, 2019 · 8 comments
Open

Updating docs to include JOSE #491

tracykteal opened this issue Feb 4, 2019 · 8 comments

Comments

@tracykteal
Copy link
Contributor

tracykteal commented Feb 4, 2019

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

@arfon
Copy link
Member

arfon commented Feb 4, 2019

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

@danielskatz
Copy link
Collaborator

I agree with @arfon

@labarba
Copy link
Member

labarba commented Feb 4, 2019 via email

@jedbrown
Copy link
Member

jedbrown commented Feb 4, 2019

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

@arfon
Copy link
Member

arfon commented Feb 5, 2019

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.

@tracykteal
Copy link
Contributor Author

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.

@arfon
Copy link
Member

arfon commented Feb 10, 2019

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.

@tracykteal
Copy link
Contributor Author

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.

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

No branches or pull requests

5 participants