Merge branch 'master' of github.com:arfon/joss

docs/editing.md

@@ -60,28 +60,28 @@ When a submission is accepted, we ask that the authors create an archive (on [Ze
 Dear Dr. Jekyll,
 
 I found you following links from the page of The Super Project and/or on Twitter. This
-message is to ask if you can help us out with a submission to JOSE (The Journal of Open
-Source Software), where I’m editor.
+message is to ask if you can help us out with a submission to JOSS (The Journal of Open
+Source Software), where I’m an editor.
 
 JOSS publishes articles about open source research software. The submission I'd like you
 to review is titled: "great software name here"
 
 and the submission repository is at: https://github.com/< … >
 
 JOSS is a free, open-source, community driven and developer-friendly online journal
-(no publisher seeking to make revenue from the volunteer labor of researchers!).
+(no publisher is seeking to raise revenue from the volunteer labor of researchers!).
 
 The review process at JOSS is unique: it is open and author-reviewer-editor conversations
 are encouraged.
 
 JOSS reviews involve downloading and installing the software, and inspecting the repository
-for key elements. See http://joss.theoj.org/about#reviewer_guidelines
+and submitted paper for key elements. See http://joss.theoj.org/about#reviewer_guidelines
 
-Editors and reviewers post comments on the REVIEW issue, and authors respond to the comments
+Editors and reviewers post comments on the Review issue, and authors respond to the comments
 and improve their submission until acceptance (or withdrawal, if they feel unable to
 satisfy the review).
 
-Would you be able to review the great submission for JOSS? Or, if not, could you recommend
+Would you be able to review this submission for JOSS? If not, can you recommend
 someone from your team to help out?
 
 Kind regards,
@@ -105,7 +105,7 @@ This doesn’t mean that you’re the editor, just that you’ve been suggested
 
 - There’s a general description of the software
 - The software is within scope as research software
-- It has an OSI approved license
+- It has an OSI-approved license
 
 **Step 5: The editor responds to the author saying that things look in line (or not) and will search for reviewer**
 

docs/index.rst

@@ -14,7 +14,8 @@ This site contains documentation for authors interested in submitting to JOSS, r
 If you're interested in learning more about JOSS, you might want to read:
 
 - `Our announcement blog post <http://www.arfon.org/announcing-the-journal-of-open-source-software>`_ describing some of the motivations for starting a new journal
-- `This paper in PeerJ-CS <https://peerj.com/articles/cs-147/>`_ describing the first year of JOSS
+- `This paper in Computing in Science and Engineering <https://doi.org/10.1109/MCSE.2018.03221930/>`_ introducing JOSS
+- `This paper in PeerJ CS <https://doi.org/10.7717/peerj-cs.147>`_ describing the first year of JOSS
 - The `about page <http://joss.theoj.org/about>`_ on the main JOSS site
 
 Submitting a paper to JOSS

docs/submitting.md

@@ -23,7 +23,7 @@ In addition, your paper should include:
 - A list of key references including a link to the software archive
 - Mentions (if applicable) of any ongoing research projects using the software or recent scholarly publications enabled by it
 
-As this short list shows, JOSS papers are only permitted to contain a limited set of metadata (see header below), Statement of Need, Summary, and Reference sections. You can see an example accepted paper [here](https://raw.githubusercontent.com/adrn/gala/f6bb2532afeed3c0b0feea3037bf71a3f42b2a12/paper/paper.md). Given this paper format it is not permitted to write a "full length" paper i.e. one that includes software documentation such as API (Application Programming Interface) functionality, as this should instead be outlined in the software documentation.
+As this short list shows, JOSS papers are only permitted to contain a limited set of metadata (see header below), Statement of Need, Summary, and Reference sections. You can see an example accepted paper [here](https://raw.githubusercontent.com/adrn/gala/f6bb2532afeed3c0b0feea3037bf71a3f42b2a12/paper/paper.md). Given this paper format, a "full length" paper is not permitted, e.g., software documentation such as API (Application Programming Interface) functionality should not be in the paper and instead should be outlined in the software documentation.
 
 ## Example paper and bibliography
 
@@ -170,6 +170,9 @@ Example `paper.bib` file:
 }
 ```
 
+Note that the paper ends with a References heading, and the references are built automatically from the content in the .bib file when they are mentioned in the paper body.
+
+
 ## Submitting your paper
 
 Submission then is as simple as:

docs/whedon.md

@@ -3,7 +3,7 @@ Interacting with Whedon
 
 Whedon or `@whedon` on GitHub, is our editorial bot that interacts with authors, reviewers, and editors on JOSS reviews.
 
-`@whedon` can do a bunch of different things. If you want to ask `@whedon` what he can do, simply type the following in a JOSS `review` or `pre-review` issue:
+`@whedon` can do a bunch of different things. If you want to ask `@whedon` what it can do, simply type the following in a JOSS `review` or `pre-review` issue:
 
 ```text
 @whedon commands
@@ -51,7 +51,7 @@ This will return an output something like this:
 
 When a `pre-review` or `review` issue is opened, `@whedon` will try to compile the JOSS paper by looking for a `paper.md` file in the repository specified when the paper was submitted.
 
-If he can't find the `paper.md` file he'll say as much in the review issue. If he can't compile the paper (i.e. there's some kind of Pandoc error), he'll try and report that error back in the thread too.
+If it can't find the `paper.md` file it will say as much in the review issue. If it can't compile the paper (i.e. there's some kind of Pandoc error), it will try and report that error back in the thread too.
 
 ```eval_rst
 .. note:: If you want to see what command ``@whedon`` is running when compiling the JOSS paper, take a look at the code `here <https://github.com/openjournals/whedon/blob/195e6d124d0fbd5346b87659e695325df9a18334/lib/whedon/processor.rb#L109-L132>`_.