From 3fc86d4c59def1313a8bcae6e0876fe648944941 Mon Sep 17 00:00:00 2001 From: Sergey Grigoriev Date: Mon, 2 Sep 2024 20:58:38 +0200 Subject: [PATCH] chore: move Asynchronous PDF Export section to Advanced configuration (#184) --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d589b99..02416ed 100644 --- a/README.md +++ b/README.md @@ -34,16 +34,6 @@ To change WeasyPrint Service URL, adjust the following property in the `polarion ch.sbb.polarion.extension.pdf-exporter.weasyprint.service=http://localhost:9080 ``` -### Asynchronous PDF Export: export jobs timeout -This extension provides REST API to export PDF asynchronously. Using this API, it is possible to start export job, observe their status and get result. -Finished (succeed or failed) and in-progress export jobs will be preserved in memory until configured timeout. To change this timeout, adjust the following property in the local `pdf-converter-jobs.properties` file: -```properties -# Timeout in minutes to keep finished async conversion jobs results in memory -jobs.timeout.finished.minutes=30 -# Timeout in minutes to wait until async conversion jobs is finished -jobs.timeout.in-progress.minutes=60 -``` - ### PDF exporter extension to appear on a Document's properties pane 1. Open a project where you wish PDF Exporter to be available @@ -196,6 +186,18 @@ ch.sbb.polarion.extension.pdf-exporter.internalizeExternalCss=true ## REST API This extension provides REST API. OpenAPI Specification can be obtained [here](docs/openapi.json). +## Advanced Configuration + +### Asynchronous PDF Export: export jobs timeout +This extension provides REST API to export PDF asynchronously. Using this API, it is possible to start export job, observe their status and get result. +Finished (succeed or failed) and in-progress export jobs will be preserved in memory until configured timeout. To change this timeout, adjust the following property in the local `pdf-converter-jobs.properties` file: +```properties +# Timeout in minutes to keep finished async conversion jobs results in memory +jobs.timeout.finished.minutes=30 +# Timeout in minutes to wait until async conversion jobs is finished +jobs.timeout.in-progress.minutes=60 +``` + ## Known issues All good so far.