Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 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
4646cc8
feat #254 Make sure to test heading links
joemull Jul 31, 2026
e96ece4
docs #241 Email template variables
joemull Jul 31, 2026
ccdd224
docs #241 Image guidelines
joemull Aug 1, 2026
5091e59
docs #241 Similarity check placeholder
joemull Aug 1, 2026
3a4cba2
docs #241 Custom styling docs
joemull Aug 1, 2026
6ea4202
docs #241 Check imports docs
joemull Aug 1, 2026
e9951a1
feat #252 Install and configure XML sitemap plugin
joemull Aug 4, 2026
590fb09
feat #252 Create 'All support pages'
joemull Aug 7, 2026
a15ed1d
chore: Move root support pages into a folder called 'About'
joemull Aug 7, 2026
90c8500
chore #278 Fix broken links
joemull Aug 7, 2026
d512cf0
chore: Fix wrong variable name in config file
joemull Aug 7, 2026
1484302
feat #275 Document managing submission access requests
joemull Aug 7, 2026
93019a6
Navigating JW guide and styleguide updates
S-Haime Aug 7, 2026
9588230
Landing page draft
S-Haime Aug 7, 2026
209f624
Re-split index and about as discussed
S-Haime Aug 7, 2026
8c296f9
chore: Link fixes and formatting
joemull Aug 9, 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
1 change: 1 addition & 0 deletions content/pages/support/about/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# About
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Title: Contributing to Janeway documentation

# Contributing to Janeway documentation

Work-in-process note: This page could explain how people including us and
Expand All @@ -11,11 +9,11 @@ how to name files and folders.
## Creating and editing pages

All the pages of the support site are generated from text files stored under
`/content/support/` in this repository. Old documentation can be found at
`/content/old-docs/` while the support site is being built.
`content/pages/support/` in this repository. Old documentation can be found at
`content/old-docs/` while the support site is being built.

Pages for the support site should be written in GitHub-flavored Markdown (GFM).
Image files should be added under `/content/support/images/`. All the content
Image files should be added under `content/pages/support/images/`. All the content
can be edited on GitHub, so that you can make use of the Preview tab in GitHub.

When creating Git commits, create a dedicated branch if you are working in
Expand All @@ -38,7 +36,7 @@ Do:
my-folder/my-file-name.txt
```

Dont:
Don't:

- use spaces (reason: shell scripting)
- use capital letters (reason: avoid broken links)
Expand All @@ -52,20 +50,10 @@ Don’t:
my&your-folder/my&your-file-name.txt
```

## Page metadata

At the beginning of the file, please include the page title, preceded by
`Title: `. It will appear in the browser tab, on search results, and on social
media when the page is shared.

The page you are reading has this at the top:

```md
Title: Contributing to Janeway documentation
```
## Headings

Please also include a top-level heading for each page, using the single hash in
Markdown syntax. Usually this will be the same as the page title.
Include a top-level heading for each page, using the single hash in
Markdown syntax.

For example:

Expand All @@ -75,7 +63,7 @@ For example:

## Internal links

If you want to link to another page in the documentation, use Markdowns link
If you want to link to another page in the documentation, use Markdown's link
syntax, but leave the extension off the file, since eventually it will be an
HTML file, not a Markdown file. For example, to create a link to this file from
another file in the same folder, you can do this:
Expand Down Expand Up @@ -126,4 +114,4 @@ Do not put any bullet or dash before the definitions, because this will cause ex

Importantly, put two spaces after the term in the first line, to maintain the line break when the Markdown is rendered.

![The words "cat" and "dog" appear next to bullet points, and descriptions appear underneath each word](./images/lists-with-definitions.png)
![The words "cat" and "dog" appear next to bullet points, and descriptions appear underneath each word](../images/lists-with-definitions.png)
78 changes: 78 additions & 0 deletions content/pages/support/about/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Janeway documentation

Janeway is an open-source publishing platform for scholarly journals, presses, and repositories. It handles the whole path from submission through peer review, copyediting, and typesetting to a published article on a public website.

These pages explain how to use Janeway, whether you are running a journal, managing a press, reviewing a manuscript, or submitting your own work.

## Guides

There are various guides available for using Janeway:

- [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.
- [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.
- [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

### Communicating and monitoring

### Managing a press

### Managing a repository

_Coming soon_

## Getting help

## Developer docs

## All pages

## About the docs
Loading
Loading