Skip to content

Commit

Permalink
fix: Add quick start
Browse files Browse the repository at this point in the history
Refs: #183
  • Loading branch information
yurtsevich-sbb committed Sep 3, 2024
1 parent 70eaeb1 commit f4dbe63
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions QUICK_START.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PDF Exporter quick start
# Quick start

### Run WeasyPrint in Docker

Expand All @@ -11,17 +11,17 @@ and copy it to `<polarion_home>/polarion/extensions/ch.sbb.polarion.extension.pd

## Specify required properties in polarion.properties file

Open file `<polarion_home>/etc/polarion.properties` in a file editor of your choice and add following properties to it:
Add following properties to file `polarion.properties`:

```properties
com.siemens.polarion.rest.enabled=true
com.siemens.polarion.rest.cors.allowedOrigins=<ANY ORIGINS WHICH ALLOWED TO REACH REST ENDPOINTS, COMMA SEPARATED>
com.siemens.polarion.rest.swaggerUi.enabled=true
ch.sbb.polarion.extension.pdf-exporter.weasyprint.service=http://localhost:9080
```

## Restart Polarion

Restart Polarion services, either yourself if you have such rights, or ask a system administrator.
Restart Polarion.

## Configure PDF Exporter for Live Reports

Expand All @@ -43,4 +43,5 @@ On admin pane of appropriate project select menu "Documents & Pages ➙ Document

## Ready to go

You are now ready to use PDF Exporter in your Polarion.
PDF Exporter is now installed and configured. You can now open a Live Document and on Documents Sidebar you will see PDF Exporter section. Also open About page of PDF Exporter on admin pane
and make sure that there are no errors in Extension configuration status table.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The extension uses [WeasyPrint](https://weasyprint.org/) as a PDF engine and req

## Quick start

Please see separate [quick start page](QUICK_START.md) were briefly summarized all most important and applicable steps and configurations.
Please see separate [quick start page](QUICK_START.md) where briefly summarized all most important and applicable steps and configurations.

If you need deeper knowledge about all possible steps, configurations and their descriptions, please see sections below.

Expand Down

0 comments on commit f4dbe63

Please sign in to comment.