Tweaking readme and adding data model glossary item.

This commit is contained in:
Simon Redfern 2019-08-22 15:57:21 +02:00
parent fc67401a26
commit 21688abb54
2 changed files with 24 additions and 2 deletions

View File

@ -82,6 +82,10 @@ To compile and run jetty, install Maven 3, create your configuration in obp-api/
Package: Select code
Add the absolute /path-to-your-OBP-API in the "working directory" field
You might need to assign more memory via VM Options: e.g. -Xmx1512M -XX:MaxPermSize=512M
or
-Xmx2048m -Xms1024m -Xss2048k -XX:MaxPermSize=1024m
Make sure your test.default.props has the minimum settings (see test.default.props.template)

View File

@ -1830,11 +1830,29 @@ object Glossary {
description =
s"""
${getWebUiPropsValue("webui_sandbox_introduction", "")}
""")
""")
glossaryItems += GlossaryItem(
title = "Data Model Overview",
description =
s"""
|
|An overview of the Open Bank Project Data Model.
|
|This model may help understand Open Bank Project. However it is subject to change. If we change the data model, we release migration scripts.
|
|
|<img width="468" alt="obp-data-model-overview" src="https://user-images.githubusercontent.com/485218/63519307-04e93480-c4f3-11e9-8bfc-b64096d2f034.png"></img>
|
|
|
""")
///////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////
// NOTE! Some glossary items are generated in ExampleValue.scala
//////////////////////////////////////////////////////////////////