Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
feb2116
chore: Move support content inside pages directory
joemull Jul 3, 2026
4ca3a0c
chore: Upgrade playwright
joemull Jul 4, 2026
743c32c
feat #236 Make support content into pages with site type
joemull Jul 4, 2026
5c88432
feat #235 Mega menu in support footer
joemull Jul 4, 2026
9658dbe
chore: Build from support suite feature branch
joemull Jul 4, 2026
6a3a966
chore: Make sure people's cached support links go to placeholder page
joemull Jul 4, 2026
7ff1cf5
Docs mvp updates
S-Haime Jul 7, 2026
9d4b23f
feat #237 Breadcrumbs for support site
joemull Jul 7, 2026
ac95745
chore: Rename some files in footer mega menu
joemull Jul 7, 2026
4b8f25b
MVP fixes
S-Haime Jul 10, 2026
a789f95
chore: Prettier formatting
joemull Jul 10, 2026
3e54722
feat #67 Configure Janeway plugin for Pelican and switch to Marko for…
joemull Jul 10, 2026
16e5088
chore: Remove unneeded title metadata
joemull Jul 10, 2026
4960344
feat #238 Render links in Markdown documents for HTML setting
joemull Jul 10, 2026
62c0a9d
docs: Edit contributing guide to remove requirement for title metadata
joemull Jul 10, 2026
cb7ae92
chore: Prettier formatting
joemull Jul 10, 2026
46bb5d3
feat #239 Style alerts and content images
joemull Jul 11, 2026
d28cb9b
feat #240 Let users get a link to a section
joemull Jul 11, 2026
33ebacc
chore: Fix URL and display bugs
joemull Jul 11, 2026
2e2545e
docs #241 Answer some dev questions
joemull Jul 11, 2026
1ee5473
Copyediting of the docs
S-Haime Jul 14, 2026
4e6139a
More copyediting
S-Haime Jul 14, 2026
f78da8d
copyediting
S-Haime Jul 14, 2026
1dfc41f
Small docs updates
S-Haime Jul 16, 2026
deb2187
chore: Lowercase file names
joemull Jul 16, 2026
e3a1e47
chore: Finish renaming placeholder files
joemull Jul 16, 2026
23cc55f
chore: Prettier formatting
joemull Jul 16, 2026
a48161f
docs #241 Account activation and metrics
joemull Jul 17, 2026
3fa3ad4
Updates
S-Haime Jul 20, 2026
09e170c
docs: Fix typo
joemull Jul 21, 2026
aa6015e
docs #241 Email, identifiers, journal management
joemull Jul 21, 2026
1655027
chore: Prettier formatting
joemull Jul 21, 2026
363cf84
Updates
S-Haime Jul 22, 2026
e8bb4a8
Addressed comments
S-Haime Jul 23, 2026
4966332
chore: Cosmetic edits and Prettier formatting
joemull Jul 24, 2026
7899a63
feat #254 Run WCAG checks on support site
joemull Jul 26, 2026
cd94d95
feat #254 Mark supplementary icons as decorative
joemull Jul 26, 2026
38a4d2b
feat #254 Fix a11y bugs related to headings
joemull Jul 26, 2026
205d07d
fix: Fix a bug with the test server that mixed pelican and pytest com…
joemull Jul 26, 2026
5dc3366
feat #254 Write a test to check links
joemull Jul 26, 2026
67b9d72
feat #254 Fix link bugs
joemull Jul 26, 2026
86c4fe9
feat #254 Test for broken image paths
joemull Jul 26, 2026
d2fe4e6
feat #254 Combine page visits so tests run faster
joemull Jul 26, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/pelican.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Deploy to GitHub Pages
on:
push:
branches: ["main"]
branches: ["main", "b-support-site-mvp"]
workflow_dispatch:
permissions:
contents: read
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/playwright.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: Ensure browsers are installed
run: python -m playwright install --with-deps
- name: Run your tests
run: pytest
run: pytest --failed-first
- uses: actions/upload-artifact@v4
if: ${{ !cancelled() }}
with:
Expand Down
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,6 @@ Documentation authors are asked to place all content in `/content/support/`,
using GitHub-flavored Markdown and including images in
`/content/support/images/`.

Pelican interprets these pages as “articles,” so minimal requirements about
having a `Title` in the YAML metadata apply.

If they are editing on GitHub.com, they can make commits on the perpetual
`copyediting` branch, or if they are working locally, they should open
a dedicated feature branch. They may often need help with pull requests and
Expand Down
2 changes: 0 additions & 2 deletions content/old-docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Title: Changelog

# Changelog

Release notes have moved to
Expand Down
2 changes: 0 additions & 2 deletions content/old-docs/dev/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Title: API

# API

API stands for Application programming interface. APIs are designed to
Expand Down
2 changes: 0 additions & 2 deletions content/old-docs/dev/configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Title: Technical Configuration

# Technical Configuration

This section will discuss the technical configuration of Janeway
Expand Down
2 changes: 0 additions & 2 deletions content/old-docs/dev/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Title: Installation Guide

# Installation Guide

There are a number of ways to get Janeway up and running. For
Expand Down
2 changes: 0 additions & 2 deletions content/old-docs/dev/oidc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Title: Open ID Connect (OIDC)

# Open ID Connect (OIDC)

Support for Open ID Connect has been added in 1.4.2 of Janeway. This
Expand Down
6 changes: 2 additions & 4 deletions content/old-docs/dev/plugins.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Title: Plugins, Events and Hooks

# Plugins, Events and Hooks

<div class="warning">
Expand Down Expand Up @@ -155,14 +153,14 @@ connect it with core areas of Janeway.
{% endraw %}

<figure>
<img src="../nstatic/typesetting-plugin-dashboard.png"
<img alt="" src="../nstatic/typesetting-plugin-dashboard.png"
class="with-border" alt="../nstatic/typesetting-plugin-dashboard.png" />
<figcaption>The typesetting plugin's dashboard template renders this
block.</figcaption>
</figure>

<figure>
<img src="../nstatic/kanban-card-example.png" class="with-border"
<img alt="" src="../nstatic/kanban-card-example.png" class="with-border"
alt="../nstatic/kanban-card-example.png" />
<figcaption>Kanban cards look like this, they use the workflow/admin css
(foundation).</figcaption>
Expand Down
2 changes: 0 additions & 2 deletions content/old-docs/dev/robotsandsitemaps.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Title: Robots and Sitemaps

# Robots and Sitemaps

In version 1.4.1 of Janeway we are introducing the generation of Robot
Expand Down
1 change: 1 addition & 0 deletions content/pages/accessibility-of-this-website.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<head>
<title>Accessibility of this website</title>
<meta name="alpha_site" content="main" />
</head>
<body>
{% call page_h1(max_char_width=16) %}
Expand Down
1 change: 1 addition & 0 deletions content/pages/copyright-and-licensing.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<head>
<title>Copyright and licensing</title>
<meta name="alpha_site" content="main" />
</head>
<body>
{% call page_h1(max_char_width=15) %}
Expand Down
1 change: 1 addition & 0 deletions content/pages/hosting.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

<head>
<title>Hosting</title>
<meta name="alpha_site" content="main" />
</head>
<body>
{% include "components/hosting_splash.html" %}
Expand Down
1 change: 1 addition & 0 deletions content/pages/icons.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<head>
<title>Icons</title>
<meta name="alpha_site" content="main" />
</head>
<body>
<div class="flow">
Expand Down
1 change: 1 addition & 0 deletions content/pages/our-story.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

<head>
<title>Our story</title>
<meta name="alpha_site" content="main" />
</head>
<body>
{% include "components/george_space_splash.html" %}
Expand Down
3 changes: 2 additions & 1 deletion content/pages/support.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
{% from "components/page_section_group.html" import page_section_group %}

<head>
<title>Support</title>
<title>Support - work in progress</title>
<meta name="alpha_site" content="main" />
</head>
<body>
{% call page_h1() %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
Title: Janeway Documentation

# Janeway Documentation
# Janeway documentation

This guide, whilst not exhaustive, provides various guides for running
articles through the workflow, configuring journals and setting up an
Expand Down
Original file line number Diff line number Diff line change
@@ -1,53 +1,45 @@
title: Displaying custom accessibility information

# Displaying custom accessibility information

## Introduction

Janeway 1.9 introduced an **Accessibility** page linked from the footer.
By default, this only shows the platform accessibility information,
however, there are settings to include custom press and/or journal specific
information. Journal information can only be displayed if the setting **Allow journal accessibility information** is switched on at the **Press**. It is off by default.
information. Journal information can only be displayed if the setting **Allow journal accessibility information** is switched on at press level. It is off by default.

## Enter press accessibility information

Press accessibility information may be entered in through the **Press manager** under **Edit press details**. There is a section for **Accessibility**, within which there is a rich-text area for **Press accessibility Information**.

Press manager | Edit press details | Accessibility | Press accessibility information
Press accessibility information may be entered in through the **Press manager** under **Edit press details**. There is a section for **Accessibility**, within which there is a rich-text area for **Press accessibility information**.

![Screenshot: Press accessibility custom information field](../images/a11y-press-custom-info.png)

## Press setting to enable journal accessibility information

After the [press accessibility information](#enter-press-accessibility-information), there is a setting to **Allow journal accessibility information**. This allows each journal to have a unique accessibility statement.

Press manager | Edit press details | Accessibility | Allow journal accessibility information

![Screenshot: Press setting to allow journal custom accessibility information](../images/a11y-press-allow-journal-info.png)

> [!NOTE]
> This setting applies to all **journals** within that **press**. It provides the option to enter text onto the journal **accessibility** page, and will be hidden from readers when it is left blank.
> This setting applies to all journals within that press. It provides the option to enter text onto the journal accessibility page, and will be hidden from readers when it is left blank.

## Enter journal accessibility text

> [!WARNING]
> The setting at press level must be switched on to make this available in the journal manager. If this section does not appear within your journal, then please contact your press manager.

Journal accessibility information may be entered through the **Journal manager** **General** page.
> The setting at press level must be switched on to make this available in the journal manager. If this section does not appear within your journal, then contact your press manager.

Journal manager | General | Accessibility | Accessibility information for the public
Journal accessibility information may be entered through the **Journal manager**, through the **General**/**Journal settings** page.

![Screenshot: Journal accessibility custom information field](../images/a11y-journal-custom-info.png)

## Tabular summary

This table summarises the information already provided within this document.

| Custom Press Text | Press setting to Allow Journal Text | Custom Journal Text | What is displayed |
| Custom press text | Press setting to allow journal text | Custom journal text | What is displayed |
| ----------------- | ----------------------------------- | ------------------- | ------------------------------------ |
| _none_ | no | _not available_ | Platform |
| _none_ | yes | _none_ | Platform |
| _none_ | yes | Journal Text | Journal Text + Platform |
| Press Text | no | _not available_ | Press Text + Platform |
| Press Text | yes | _none_ | Press Text + Platform |
| Press Text | yes | Journal Text | Journal Text + Press Text + Platform |
| _none_ | yes | Journal text | Journal text + Platform |
| Press text | no | _not available_ | Press text + Platform |
| Press text | yes | _none_ | Press text + Platform |
| Press text | yes | Journal text | Journal text + Press text + Platform |
3 changes: 3 additions & 0 deletions content/pages/support/accessibility/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Accessibility

_Coming soon_
69 changes: 69 additions & 0 deletions content/pages/support/accounts-and-roles/activating-accounts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Activating accounts

This page explains how to check whether a user account has been activated and how to activate inactive accounts. As users must activate their account before they can log in to Janeway, inactive accounts are a common cause of login issues.

## Inactive users

There are two places from which to check and manage the activation status of accounts:

- **Journal users**
- **Inactive users**

Both are found under **Users & roles** on the Manager dashboard. The **Journal users** page is available to editors and journal managers, whereas the **Inactive users** page is accessible to staff only.

To view inactive users:

1. Open **Journal users**.
2. Use the filter on the left-hand side.
3. Set **Status** to **Inactive**.
4. Click **Apply**.

This will list all inactive users on the journal. You can also search by name or email address.

The **Inactive users** page lists all inactive users across the press who have not yet activated their accounts.

## Activating accounts

Once you have identified an inactive account through either **Journal users** or **Inactive users**:

1. Go to **Journal users** on the **Manager** interface.
2. Find the user in question through the searchbox and/or filter by account activation status.
!["A screenshot of the search options for the user search. Including a text field and various filters."](../images/search-inactive.png)
3. Click **Edit** for the appropriate user.
![" "](../images/edit-user.png)
4. Set the account activation toggle to **Yes**.
![Account activation toggle.](../images/active-toggle.png)
5. Make sure to save the change made by clicking the **Save** button at the bottom of the page.
6. The account is now active.

The user will now be able to log in to the journal.

## Troubleshooting account activation

Users usually activate through a link sent to them. Activation emails cannot be easily resent, if the user cannot find the original. The solution is for the user to click the password reset link. If they receive the password reset email and click on that link, Janeway activates their account in addition to resetting their password.

Completing the account activation step does not trigger an email. The user only receives a message saying “Account activated” at the top of the login screen, which is where they are sent next.

### Troubleshooting ORCID activation

After completing account registration via ORCID, users may or may not need to complete the activation step.

- If the user has made an email address public on orcid.org, then Janeway is able to get an email from ORCID, and it can be confident the user did not make a mistake entering their email address, so there is no need to make them find an email link to activate their account. It just logs marks their account as active.

- However, if no email is public on orcid.org, Janeway can’t be as sure of the email, so it requires the user to do account activation by emailing them a link. Email-based account activation is also triggered if the user logs in via ORCID, reaches the Janeway registration page with email from ORCID pre-populated, and then changes the email address in registration form, because again Janeway can’t be sure the email has no typos, and it is important for it to be correct, so that users do not lose access to their account if they forget their password.

### Troubleshooting author account activation

Author accounts don’t get activation any differently from other accounts. It just depends whether someone has logged in to Janeway fully. You can’t log in without activating your account, and you can’t submit an article (as main author actually doing things in Janeway) without being logged in.

Historically, accounts were created for all co-authors, and they were inactive by default (except for the submitting author--theirs was active). But this is no longer the case from version 1.8. Only author records are created, not accounts. So if co-authors want to create accounts, they need to do the same registration and activation steps as everyone else.

### Troubleshooting reviewer account activation

From version 1.8, reviewers are able to review things without logging in, so they won’t have to have active accounts unless they have another reason to. The exception is if a journal has turned one-click review off.

From version 1.8 onwards, inactive review accounts are also visible in the editor's reviewer selection screen.

Usually the reason accounts are not active is because activation is off by default, and the user has to activate with the email link, or through another mechanism like ORCID or OIDC, where Janeway can be confident the email address is correct.

There is one scenario in which the system changes previously active accounts to inactive: if the user starts the email change process, the system marks the account inactive and requires activation via email link, so we can be sure the email doesn’t contain typos.
41 changes: 41 additions & 0 deletions content/pages/support/accounts-and-roles/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Accounts and roles

This section explains how user accounts and permissions work in Janeway, including how roles are assigned and managed. Read the following pages for more information:

- [Managing user accounts](../accounts-and-roles/managing-user-accounts.md)
- [Roles and permissions](../accounts-and-roles/roles-and-permissions-on-janeway.md)
- [Activating accounts](../accounts-and-roles/activating-accounts.md)
- [ORCID login](../accounts-and-roles/orcid-login.md)
- [Single sign-on (SSO)](#single-sign-on-sso-login)

## New accounts

There are two ways to create an account on Janeway:

1. A user registers for an account through the journal website.
2. An editor, press manager or member of staff can create an account through **Journal users**.

Generally, it is best to let a user register an account using the first option and then assign any roles as needed, see [Roles and permissions](./roles-and-permissions-on-janeway.md). If this is not possible, indivual user accounts can be created by following these steps:

1. Go to the **Journal users** page on the Manager dashboard.
2. Click **Add new user**
3. Fill in the user's details.
a. Make sure the **Is active** toggle is set to "Yes".
b. Except if this user requires staff permissions, make sure the **Is staff** permission is set to "No".
c. You will be required to set a password.
4. Click **Save**.

The user can now either login after requesting a password reset link, through the journal website, or you could send a user their password. The latter is discouraged, as this introduces security risks.

## Single sign-on (SSO) login

Janeway supports single sign-on (SSO), allowing users to log in using their institutional credentials. SSO shows up on the login screen as a button reading “Log in with [name of institution]”

When users log in with SSO the first time, Janeway creates a regular account in the background, recording the name and email that it gets from the SSO system.

Users who originally signed in with SSO can switch to regular login after resetting their password from the login screen. Likewise, users who registered a normal Janeway account can start using SSO if their Janeway account email address matches the one they use with their institution.

> [!TIP]
> If you do not see the SSO login option on your installation of Janeway, then it has not been configured. Contact your system administrator for help configuring SSO.

For information on setting up SSO, see the [Janeway developer docs](https://github.com/openlibhums/janeway/tree/master/docs) - [OIDC specifically](https://github.com/openlibhums/janeway/blob/master/docs/source/dev/oidc.rst), for more information.
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
title: Managing user accounts

# Managing user accounts

The **Users and roles** section of the Manager dashboard has various controls for managing users and permissions. Who can manage what will depend on their role and permissions associated with it.

**Editors** and **Journal managers** can:
Editors and journal managers can:

- Manage user accounts at the journal level.
- Assign and remove roles for users on the journal.
- View and update account activation status.

**Staff** have additional controls for:
Staff have additional controls for:

- Viewing all accounts for the press (Janeway installation), including their journal roles and activation status.
- Merging duplicate user accounts.
Expand All @@ -33,7 +31,7 @@ From this page you can:

Each user's assignment history (for example, editorial or review activity) is also available from this view.

This page cannot be used to delete accounts, only deactivate them. Accounts can only be deleting using through the **Admin area** <!-- missing hyperlink -->.
This page cannot be used to delete accounts, only deactivate them. Accounts can only be deleted using through the **Admin area** <!-- missing hyperlink -->.

## All press users

Expand All @@ -49,25 +47,31 @@ At press level you can:

## Editing user accounts

Click **Edit** next to a user to open the **Edit user** interface, where you can update a users account details.
Click **Edit** next to a user to open the **Edit user** interface, where you can update a user's account details.

Some changes are restricted by permission level. For more information, see the **Permissions** page. <!--missing hyperlink-->
Some changes are restricted by permission level. For more information, see the [**Permissions** page](./roles-and-permissions-on-janeway.md).

> [!IMPORTANT]
> Editing a user account does **not** change author metadata on articles that have already been accepted.
> To update author details on an accepted article, you must edit the _frozen author record_ on the articles metadata page.
> To update author details on an accepted article, you must edit the _frozen author record_ on the article's metadata page.

## Merge users (staff only)

When users have multiple accounts (often due to different email addresses having been used), it may be helpful to merge accounts. Users with staff permission can merge two user accounts to remove duplicates, using the **Press manager interface**. When searching for users to merge, note that the user account in the left column (source account) will be merged into the user account in the right column (destination account).

![The merge users page](../images/merge-users.png)

> [!WARNING]
> An account merge **cannot** be undone. Only merge account when you are certain they can be merged.

When accounts are merged:

- All associated items (including articles, tasks, roles and files) are transferred from the source account to the destination account.
- All associated items (including articles, tasks, roles, and files) are transferred from the source account to the destination account.
- The destination account profile is retained.
- Any profile information from the source account is permanently lost. <!--check how much of this is the case -->
- Any profile information from the source account is permanently lost. This includes information like email, name, ORCID ID, social media usernames, and preferences about things like profile visibility and preferred timezone.

## Authenticated users

The **Authenticated users** page shows a list of users currently logged in to your Janeway installation.

<!-- ![A press manager is merging Andy Byers' account into Katheryn Janeway's account.](../images/merge-users.gif) -->
This page is only accessible to users with staff permission.
Loading
Loading