Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.44 KB

README.adoc

File metadata and controls

49 lines (31 loc) · 2.44 KB
Raw

Scout Docs - Build

Description

This folder contains the documents that are build.

  • helloworld: produces an article as single page to explain how to create an demo application (the html version is published on the scout webpage).

  • install-guide: produces an article as single page to explain how to downlaod the scout IDE (the html version is published on the scout webpage).

  • beginners-guide: produces a book called "Eclipse Scout Beginners Guide".

  • technical-guide: produces a book called "Eclipse Scout: Technical Guide".

  • migration-guide: produces an article called "Eclipse Scout: Migration Guide".

  • eclipse_help: produces the necessary pages for the "Eclipse Scout User Guide" (in the org.eclipse.scout.sdk.s2e.doc plugin). IMPORTANT: The list of pages needs to be kept up to date and ordered in help-pages.txt. In case help-pages.txt gets out of sync with the available *.adoc source files the Maven publish step may fail.

  • publish: this last step prepares all the documents in order to publish them (post processing of the Asciidoctor documents). You should run the other tasks, before running this task.

Usage

You can generate all documents using maven at the root of the build folder:

mvn

You can generate one document by switching to one of subfolder and using maven:

cd helloworld/
mvn

The results are generated in the target subfolder. For example for helloworld:

helloworld/target/generated-docs/helloworld.html
helloworld/target/generated-docs/helloworld.pdf

Eclipse Help

This part of the output is the "Eclipse Scout User Guide" delivered as part of the Scout SDK.

This output needs to be synced with the org.eclipse.scout.sdk.s2e.doc plugin in the org.eclipse.scout.sdk repository. The content of scout-sdk-help should be copied inside org.eclipse.scout.sdk.s2e.doc.

Eclipse.org/scout website

This part of the output contains the pages published on the Scout Homepage:

The files are included using an iframe by the Scout homepage and therefore don’t need to be published separately.

Documentation for download

This part of the output contains the documents ready for downloads.

This output is manually pushed to https://eclipsescout.github.io/