The journal management-related sections of the documentation needed upgrading, as much of this had not seen much work before. This work initially started out as putting 'scaffolding' in place for content, but with review availability, it was decided that rather have multiple smaller branches (b-preparation-for-more being the first of them) that this work should be on one large branch. The focus still being on journal management-related work, but other areas may have received minor edits (to avoid various smaller branches).
This now includes:
- Clarity edits and updates for roles and permissions. This should make the content usable for users, whilst we wait on some devdocs around roles and permissions.
- Work on using email templates and variables. It aims to make this part of Janeway more accessible to users and give them a clear idea of what is/isn't possible.
- There has been a lot of confusion from users around how to edit email templates and how variables work. This piece of work will hopefully help with this. We may need to test it / QA it with someone as it's one of the trickier parts of the manager interface.
- Slight rewriting of parts of the identifiers documentation, based on some of the gaps identified + user feedback. The DataCite elements still need additional work and documentation.
- Explanation of what the cache is and why someone may wish to clear it.
- Carousel configuration guidance. (New page.)
- Journal management landing page, to help users find the documentation they need. (New page.)
- Edits around indentation, capitalisation, punctuation and other formatting/copyediting details.
#171 is a copyedit by Emily of the review and submission docs. It was suggested to be done from this branch to avoid more conflicts between branch creation and review, as we ran into some before.
We will likely look at merging b-preparation-for-more once the copyediting is merged and there is review capacity.
The journal management-related sections of the documentation needed upgrading, as much of this had not seen much work before. This work initially started out as putting 'scaffolding' in place for content, but with review availability, it was decided that rather have multiple smaller branches (
b-preparation-for-morebeing the first of them) that this work should be on one large branch. The focus still being on journal management-related work, but other areas may have received minor edits (to avoid various smaller branches).This now includes:
#171 is a copyedit by Emily of the review and submission docs. It was suggested to be done from this branch to avoid more conflicts between branch creation and review, as we ran into some before.
We will likely look at merging
b-preparation-for-moreonce the copyediting is merged and there is review capacity.