diff --git a/content/pages/support/about/index.md b/content/pages/support/about/index.md index edca1519..e9eacb43 100644 --- a/content/pages/support/about/index.md +++ b/content/pages/support/about/index.md @@ -4,75 +4,60 @@ Janeway is an open-source publishing platform for scholarly journals, presses, a These pages explain how to use Janeway, whether you are running a journal, managing a press, reviewing a manuscript, or submitting your own work. +## Table of contents + +Each of the links listed below corresponds to a section of the documentation, ordered by theme. Each page will link to more detailed pages for more information on the topic. + +- [Accessiblity](../accessibility/index.md) +- [Accounts and roles](../accounts-and-roles/index.md) +- [Analytics](../analytics/index.md) +- [Article management](../article-management/index.md) +- [Emails and reminders](../email-and-reminders/index.md) +- [Guides](../guides/index.md) +- [Managing identifiers](../identifiers/index.md) +- [Importing, exporting and updating data](../plugins/imports-plugin.md) +- [Managing issues, volumes and collections](../issues-volumes-and-collections/index.md) +- [Journal management](../journal-management/index.md) +- [Plugins](../plugins/index.md) +- [Press management](../press-management/index.md) +- [Repositories](../repository/index.md) +- [Review](../review/index.md) +- [Submission](../submission/index.md) + ## Guides There are various guides available for using Janeway: +- [Janeway guides overview](../guides/index.md) - [Getting started with Janeway](../guides/getting-started.md) - These guides will help you set up your account, navigate Janeway and -if you are an editor or press manager- configure your first journal. + These guides will help you set up your account, navigate Janeway and - if you are an editor or press manager - configure your first journal. - [Workflow guides](../guides/index.md#workflow-guides) Each guide covers one role (e.g., author, reviewer, typesetter) from start to finish, so you can read only the parts that apply to you. +- [Editor guides](../guides/editor-guide-overview.md) + The guides for the six stages of the editor's workflow. - [Troubleshooting](../guides/index.md#troubleshooting) Common problems and their solutions are outlined here. - [Setup and configuration](../guides/index.md#setup-and-configuration) If you are setting up or configuring a journal, these guides collate and link to information that may be helpful. -## Browse by theme - -### Accessibility - -### Accounts and roles - -### Analytics - -### Article management - -### Emails and reminders - -### Managing identifiers - -### Importing, exporting and updating data - -### Managing issues, volumes and collections - -### Journal management - -### Plugins - -### Press management - -### Repositories - -### Configuring review - -### Configuring submission - -_To be continued_ - -## Browse by task - -### Set up your journal - -### Styling your journal - -### Handle peer review - -### Prepare and publish content - -### Managing your journal website +_Coming soon_ -### Communicating and monitoring +## All pages -### Managing a press +## Getting help -### Managing a repository +If the documentation does not answer your question, help is available. -_Coming soon_ +- For questions about your journal's policies and specific processes, ask your editor or press manager. +- For technical problems, configuration questions, or anything in the admin area, contact your system administrator (if self-hosted) or Janeway support. +- If your system administrator cannot resolve the problem, contact Janeway support. -## Getting help +Please note that if you are a self-hosted user, the support team will not have access to your install and may not be able to resolve the issue directly. ## Developer docs -## All pages - ## About the docs + +- [About the documentation](../about/index.md) +- [The documentation styleguide](../about/janeway-styleguide.md) +- [Contributing to the documentation](../about/contributing-guide.md) diff --git a/content/pages/support/guides/index.md b/content/pages/support/guides/index.md index 8361a663..9553f20b 100644 --- a/content/pages/support/guides/index.md +++ b/content/pages/support/guides/index.md @@ -1,13 +1,38 @@ # Janeway guides -This is a landing page for guides available. +This page lists the guides for using Janeway. Guides are grouped by theme and who they are for. ## Workflow guides -## Troubleshooting +- [Author guide](../guides/author-guide.md) - submitting an article and going through the publication process as an author. +- [Reviewer guide](../guides/reviewer-guide.md) - accessing and completing reviews as a reviewer. +- [Copyeditor guide](../guides/copyeditor-guide.md) - managing assignments as a copyeditor. +- [Typesetter guide](../guides/typesetter-guide.md) - typesetting content on Janeway. + +- [Editor guide: overview](../guides/editor-guide-overview.md) - the stages of the editorial workflow, with links to each stage's specific guide. + - [Editor guide: submission](../guides/editor-guide-to-submission.md) - managing new submissions and making an initial decision. + - [Editor guide: review](../guides/editor-guide-to-review.md) - setting up peer reviews, assigning reviewers and recording article decisions. + - [Editor guide: review - draft decisions](../guides/editor-guide-to-draft-decisions.md) - how to work with section editors who can submit draft decisions for approval, before being sent to the author(s). + - [Editor guide: copyediting](../guides/editor-guide-to-copyediting.md) - assigning and managing copyediting tasks. + - [Editor guide: typesetting](../guides/editor-guide-to-typesetting.md) - the typesetting workflow(s) in Janeway, proofing and managing additional files. + - [Editor guide: typesetting - Pandoc](../guides/editor-guide-to-typesetting-with-pandoc.md) - typesetting using Pandoc for converting to HTML and PDF galleys. + - [Editor guide: prepublication](../guides/editor-guide-to-prepub.md) - the final checks (metadata, issue, DOI, notifications, etc.) before an article is published. ## Setup and configuration -- Getting started guide +- [Getting started guide (_in progress_)](../guides/getting-started.md) + - [Creating an account](../guides/creating-an-account-on-janeway.md) - how to register an account on Janeway. + - [Navigating Janeway](../guides/navigating-janeway.md) - how to navigate the various parts of a Janeway website. +- [Setting up a journal](../guides/journal-setup.md) - creating a journal, configuring it and opening it for submissions. +- [Journal design (_in progress_)](../guides/journal-design.md) +- [Metadata on Janeway (_in progress_)](../guides/metadata-on-janeway.md) - a guide to metadata fields and how author, issue and article metadata are managed. + +## Repositories + +- [Setting up Janeway repository](../repository/setting-up-a-repository-with-janeway.md) - setting up and configuring a repository. +- [Moderator guide](../repository/moderator-guide.md) - moderating and managing a repository. +- [Submitting to a Janeway repository](../repository/submitting-to-a-janeway-repository.md) - what to expect when submitting to a repository. + +## Troubleshooting -_Coming soon_ +- [Account troubleshooting](../guides/account-troubleshooting.md) diff --git a/content/pages/support/guides/journal-setup.md b/content/pages/support/guides/journal-setup.md index 3c279d95..a5fa995f 100644 --- a/content/pages/support/guides/journal-setup.md +++ b/content/pages/support/guides/journal-setup.md @@ -10,7 +10,7 @@ You do not have to do everything in one sitting. Most settings can be changed la Creating a journal happens at press level and needs staff permission. If you are an editor, you cannot do this yourself - you will need to contact your press manager or system administrator. Once the journal exists and you have the editor or journal manager role, you can work through the rest of this guide. -Everything after [Creating a journal](#creating-a-journ) is available to editors and journal managers, with two exceptions noted in the text: press-level settings and the admin area. For a full breakdown of who can do what, see [Roles and permissions on Janeway](../accounts-and-roles/roles-and-permissions-on-janeway.md). If you have not worked in Janeway before, read [Navigating Janeway](./navigating-janeway.md) first so the interfaces mentioned below make sense. +Everything after [Creating a journal](#creating-a-journal) is available to editors and journal managers, with two exceptions noted in the text: press-level settings and the admin area. For a full breakdown of who can do what, see [Roles and permissions on Janeway](../accounts-and-roles/roles-and-permissions-on-janeway.md). If you have not worked in Janeway before, read [Navigating Janeway](./navigating-janeway.md) first so the interfaces mentioned below make sense. ### Information you'll need