Merge branch 'main' into l10n_main2

_config.yml

@@ -24,5 +24,10 @@ readme_index:
   enabled: true
   remove_originals: false
   with_frontmatter: true
+include:
+  - _all-skins.css # For the SchemaSpy database documentation (Jekyll excludes files that start with _)
+  - _all-skins.min.css # For the SchemaSpy database documentation (Jekyll excludes files that start with _)
+exclude:
+  - dev/ui-library/**/*.md # For the Readme.md files included in the fonts directory (Jekyll will try to make a page out of it)
 plugins:
   - jekyll-sitemap

_data/dev.yml

@@ -25,10 +25,12 @@ cards:
         isDeveloper: true
   - path: dev
     title: Specifications and Reference Guides
-    description: Technical documentation such as the REST API schema, UI Library, and application source references.
+    description: Technical documentation about the REST API, database schema, the UI Library, and application source code.
     cards:
       - path: rest-api
         isDeveloper: true
+      - path: database-schema
+        isDeveloper: true
       - path: ui-library
         isDeveloper: true
       - path: ojs-reference

_data/versions.yml

@@ -1,3 +1,6 @@
+admin-guide:
+  3.4: /admin-guide
+  3.3: /admin-guide/3.3/en
 api:
   ojs:
     3.2: /dev/api/ojs/3.2/
@@ -9,19 +12,25 @@ crossref-ojs-manual:
 dev-documentation:
   3.4: /dev/documentation/en
   3.3: /dev/documentation/3.3/en
+dev-plugin-guide:
+  3.4: /dev/plugin-guide/en
+  3.3: /dev/plugin-guide/3.3/en
 importing-exporting:
   current: /importing-exporting/en/
   3.0: /importing-exporting/3.0/en/
 learning-ojs:
-  3.3: /learning-ojs/
+  3.4: /learning-ojs/
+  3.3: /learning-ojs/3.3/
   3.2: /learning-ojs/3.2/
   3.1: /learning-ojs/3.1/
 learning-omp:
-  3.3: /learning-omp/
+  3.4: /learning-omp/
+  3.3: /learning-omp/3.3/
   3.2: /learning-omp/3.2/
   3.1: /learning-omp/3.1/
 learning-ops:
-  3.3: /learning-ops/
+  3.4: /learning-ops/
+  3.3: /learning-ops/3.3/
   3.2: /learning-ops/3.2/
 translating-guide:
   3.2: /translating-guide/

_includes/cards/dev/admin-guide.md

@@ -1,8 +1,8 @@
 
 ### [Administrator's Guide](/admin-guide/en)
 
-A guide for system administrators on how to install and upgrade, import and export, process statistics, troubleshoot problems, and more. [View Now](/admin-guide/en)
+How to install and configure the application, import and export data, secure your server, download statistics, and troubleshoot problems. [View Now](/admin-guide/en)
 
 ---
 
-<span class='fa fa-language'></span> Available in [Français](/admin-guide/fr/).
+Versions: [3.4](/admin-guide/en), [3.3](/admin-guide/3.3/en/) ([Français](/admin-guide/3.3/fr/))

_includes/cards/dev/database-schema.md

@@ -0,0 +1,4 @@
+
+### [Database Schema](/dev/database/)
+
+Reference documentation for the database schemas of OJS, OMP and OPS. [View Now](/dev/database/)

_includes/cards/dev/plugin-guide.md

@@ -1,4 +1,8 @@
 
-### [Plugin Guide](./plugin-guide/en)
+### [Plugin Guide](/dev/plugin-guide/en)
 
 Learn how to write plugins to customize almost anything in OJS and OMP. [View Now](./plugin-guide/en)
+
+---
+
+Versions: [3.4](/dev/plugin-guide/en), [3.3](/dev/plugin-guide/3.3/en)

_includes/cards/dev/release-notebooks.md

@@ -1,8 +1,8 @@
 
 ### [Release Notebooks](/dev/release-notebooks)
 
-Essential guidance on changes to the application code for each new release. [View Now](/dev/release-notebooks)
+Essential guidance on changes for hosts, developers and contributors for each new release.. [View Now](/dev/release-notebooks)
 
 ---
 
-Notebooks: [3.3](/dev/release-notebooks/en/3.3-release-notebook), [3.2](/dev/release-notebooks/en/3.2-release-notebook)
+Notebooks: [3.4](/dev/release-notebooks/en/3.4-release-notebook), [3.3](/dev/release-notebooks/en/3.3-release-notebook), [3.2](/dev/release-notebooks/en/3.2-release-notebook)

_includes/cards/dev/rest-api.md

@@ -1,8 +1,8 @@
 
 ### [REST API Usage Guide](/dev/api)
 
-Helpful hints and complete technical references for using OJS 3's REST API. [View Now](/dev/api)
+Technical documentation for using the REST API in OJS. [View Now](/dev/api)
 
 ---
 
-References: [3.3](/dev/api/ojs/3.3), [3.2](/dev/api/ojs/3.2), [3.1](/dev/api/ojs/3.1)
+References: [3.4](/dev/api/ojs/3.4), [3.3](/dev/api/ojs/3.3), [3.2](/dev/api/ojs/3.2), [3.1](/dev/api/ojs/3.1)

_includes/cards/dev/ui-library.md

@@ -1,4 +1,4 @@
 
-### [UI Library](/dev/ui-library/dev)
+### [UI Library](/dev/ui-library/)
 
-Component library, documentation and style guide for developers working with the user interface for OJS 3's editorial backend. [View Now](/dev/ui-library/dev)
+Component library, documentation and style guide for developers working with the user interface for OJS 3's editorial backend. [View Now](/dev/ui-library/)

_includes/cards/ojs3/developer-docs.md

@@ -5,7 +5,7 @@ Guides to host and deploy OJS, write themes and plugins, and contribute new feat
 
 ---
 
-- [Administrator's Guide](/admin-guide/)
+- [Administrator's Guide](/admin-guide/en/)
 - [How to Upgrade](/dev/upgrade-guide/en/)
 - [Main Documentation](/dev/documentation/en/)
 - [Theming Guide](/pkp-theming-guide/)

_includes/cards/ojs3/plugin-guides.md

@@ -8,3 +8,4 @@ These guides explain how to use OJS plugins. Plugins integrate OJS with services
 - [Crossref Plugin Guide](/crossref-ojs-manual/en/)
 - [ORCID Plugin Guide](/orcid/en/)
 - [PayPal Plugin Guide](/using-paypal-for-ojs-and-ocs/en/)
+- [ROR Plugin Guide](/ror-plugin/en)

_includes/cards/ojs3/starting-a-journal.md

@@ -3,6 +3,6 @@
 
 [Frequently Asked Questions (FAQ)](/faq/en/): How to use PKP software and common troubleshooting issues.
 
-[Launch a new journal](/starting-a-journal/): A step-by-step checklist.
+[Short Guide to Starting a New Journal](/starting-a-journal/): A short guide for editors wishing to launch a new journal.
 
 [Journal policies and workflows](/journal-policies-workflows/en/): A guide to common journal practices.

_includes/cards/omp3/developer-docs.md

@@ -5,9 +5,9 @@ Guides to host and deploy OJS, write themes and plugins, and contribute new feat
 
 ---
 
-- [Administrator's Guide](/admin-guide/)
-- [How to Upgrade](/dev/upgrade-guide/)
-- [Main Documentation](/dev/documentation/)
+- [Administrator's Guide](/admin-guide/en/)
+- [How to Upgrade](/dev/upgrade-guide/en/)
+- [Main Documentation](/dev/documentation/en/)
 - [Theming Guide](/pkp-theming-guide/)
-- [Plugin Guide](/dev/plugin-guide/)
+- [Plugin Guide](/dev/plugin-guide/en/)
 - ... and [more](/dev/)

_includes/cards/ops3/developer-docs.md

@@ -5,9 +5,9 @@ Guides to host and deploy OJS, write themes and plugins, and contribute new feat
 
 ---
 
-- [Administrator's Guide](/admin-guide/)
-- [How to Upgrade](/dev/upgrade-guide/)
-- [Main Documentation](/dev/documentation/)
+- [Administrator's Guide](/admin-guide/en/)
+- [How to Upgrade](/dev/upgrade-guide/en/)
+- [Main Documentation](/dev/documentation/en/)
 - [Theming Guide](/pkp-theming-guide/)
-- [Plugin Guide](/dev/plugin-guide/)
+- [Plugin Guide](/dev/plugin-guide/en/)
 - ... and [more](/dev/)

admin-guide/3.3/en/SUMMARY.md

@@ -0,0 +1,44 @@
+# Table of contents
+
+* [Getting Started](./)
+  * [Requirements](./requirements)
+  * [Download](./download)
+  * [Configure](./configure)
+  * [Install](./install)
+* [Securing Your System](securing-your-system.md)
+  * [The Basics](./securing-your-system.md#the-basics)
+  * [Deploying PKP Software Securely](./securing-your-system.md#deploying-pkp-software-securely)
+  * [Encryption](./securing-your-system.md#encryption)
+  * [Managing Spam](./securing-your-system.md#managing-spam)
+* [Data Import and Export](data-import-and-export.md)
+  * [Import and export articles and issues](./data-import-and-export.md#import-and-export-articles-and-issues)
+  * [Import and export users](./data-import-and-export.md#import-and-export-users)
+  * [Export metadata to external sites and indexing services](./data-import-and-export.md#export-metadata-to-external-sites-and-indexing-services)
+  * [Use import/export plugins from the command line](./data-import-and-export.md#use-importexport-plugins-from-the-command-line)
+  * [Troubleshoot importing and exporting](./data-import-and-export.md#troubleshoot-importing-and-exporting)
+* [Statistics](statistics.md)
+  * [Introduction to the Statistics Framework](./statistics.md#introduction-to-the-statistics-framework)
+  * [Configure the Statistics Framework](./statistics.md#configure-the-statistics-framework)
+  * [Processing Log Files](./statistics.md#processing-log-files)
+  * [Frequently Asked Questions](./statistics.md#frequently-asked-questions)
+  * [Frequently Encountered Statistics Problems](./statistics.md#frequently-encountered-statistics-problems)
+  * [Legacy Statistics & Statistics in OJS 2](./statistics.md#legacy-statistics--statistics-in-ojs-2)
+  * [Further Resources](./statistics.md#further-resources)
+* [Email](email.md)
+  * [Sending Mail](./email.md#sending-mail)
+  * [Setting a Bounce Address](./email.md#setting-a-bounce-address)
+  * [Email and Locale](./email.md#email-and-locale)
+  * [Primary and Technical Contacts](./email.md#primary-and-technical-contacts)
+  * [Email Validation for New Users](./email.md#email-validation-for-new-users)
+  * [Configuring the System to use Gmail SMTP](./email.md#configuring-the-system-to-use-gmail-smtp)
+  * [SPF and DMARC Issues](./email.md#spf-and-dmarc-issues)
+  * [Troubleshooting Email Problems](./email.md#troubleshooting-email-problems)
+* [User Authentication and Single Sign-on](single-signon.md)
+  * [LDAP](./single-signon.md#setting-up-ldap)
+  * [Shibboleth](./single-signon.md#setting-up-shibboleth)
+  * [Resources](./single-signon.md#resources)
+* [Troubleshooting](troubleshooting.md)
+  * [Permissions, File Access, Etc.](./troubleshooting.md#permissions-file-access-etc)
+  * [Character Encoding](./troubleshooting.md#character-encoding)
+  * [Error-reporting](./troubleshooting.md#error-reporting-blank-pages-diagnostics-etc)
+* [Appendix A: Create a Protected OJS 3 Sandbox Staged with Git](appendix-1.-create-a-protected-ojs-3-sandbox-staged-with-git.md)

admin-guide/en/appendix-1.-create-a-protected-ojs-3-sandbox-staged-with-git.md → admin-guide/3.3/en/appendix-1.-create-a-protected-ojs-3-sandbox-staged-with-git.md

@@ -1,3 +1,7 @@
+---
+book: admin-guide
+version: 3.3
+---
 # Appendix A: Create a Protected OJS 3 Sandbox Staged with Git
 
 The following document describes a general workflow for creating a git-based sandbox of a production journal that is not currently on git. It provides instructions on how to limit accidental access, outgoing email, etc. YMMV. Adapt for your own environment; use at your own risk.

admin-guide/en/configure.md → admin-guide/3.3/en/configure.md

@@ -1,6 +1,8 @@
 ---
 title: Configure - Admin Guide - PKP Developer Docs
 description: A guide to the configuration settings for Open Journal Systems (OJS), Open Monograph Press (OPS) or Open Preprint Systems (OPS).
+book: admin-guide
+version: 3.3
 ---
 
 # Configure
@@ -118,19 +120,6 @@ php tools/runScheduledTasks.php
 
 If you are unable to configure this cron job, you must enable the Acron plugin after you have installed the software.
 
-## Job Runner
-
-Some tasks can be resource intensive, such as sending large emails or recompiling the search index. By default, these jobs will be processed during normal web requests, which may impact your site's performance.
-
-We recommend using a worker daemon to process jobs. Run the following command to see options for running a worker daemon.
-
-```
-php lib/pkp/tools/jobs.php work --help
-```
-
-When running a worker daemon, you should use something like [Supervisor](http://supervisord.org/) to keep the workers running.
-
-
 ## Pretty URLs
 
 Enable URL rewriting on your server in order to change ugly URLs like `?journal=publicknowledge&page=article&op=view` into user-friendly URLs like `/publicknowledge/articles/view/1`.
@@ -163,6 +152,4 @@ restful_urls = On
 
 The configuration file includes settings to control the default date formats, manage HTTP proxies, and more. Please read the `config.inc.php` file for an explanation of every setting.
 
----
-
 Once you have configured everything, you are ready to [run the install](./install).