-
Back
+
Back | Chat with us | New bug or feature request
ApplicationPackage
Integration Diagram
@@ -23,22 +23,22 @@
Application Index
| MobileApp |
Another |
-../../../../demo/simple2.sysl |
+https:/github.com/anz-bank/sysl-catalog/blob/master/demo/simple2.sysl |
| MobileApp |
Login |
-../../../../demo/simple2.sysl |
+https:/github.com/anz-bank/sysl-catalog/blob/master/demo/simple2.sysl |
| MobileApp2 |
SecondEndpoint |
-../../../../demo/simple2.sysl |
+https:/github.com/anz-bank/sysl-catalog/blob/master/demo/simple2.sysl |
| MobileApp2 |
ThirdEndpoint |
-../../../../demo/simple2.sysl |
+https:/github.com/anz-bank/sysl-catalog/blob/master/demo/simple2.sysl |
@@ -57,7 +57,7 @@
Application MobileApp
- this is a comment for MobileApp
-
MobileApp Another
+
MobileApp Another
hello, world
Sequence Diagram
@@ -75,7 +75,7 @@ Response types
-
MobileApp Login
+
MobileApp Login
hello, gamers
Sequence Diagram
@@ -97,7 +97,7 @@ Application MobileApp2
- this is a comment for MobileApp
-MobileApp2 SecondEndpoint
+MobileApp2 SecondEndpoint
SecondEndpoint, comment
Sequence Diagram
@@ -115,7 +115,7 @@ Response types
-MobileApp2 ThirdEndpoint
+MobileApp2 ThirdEndpoint
ThirdEndpoint comment
Sequence Diagram
diff --git a/demo/html/FirstDivision/index.html b/demo/html/FirstDivision/index.html
index 56b8adb..9cc9056 100644
--- a/demo/html/FirstDivision/index.html
+++ b/demo/html/FirstDivision/index.html
@@ -2,11 +2,11 @@
-Sysl Catalog
+Sysl Catalog
-
Back
+
Back | Chat with us | New bug or feature request
FirstDivision
@@ -23,7 +23,7 @@ FirstDivision
Integration Diagram
End Point Analysis Integration Diagram
-
+
-A couple of months pass and now there’s another team which relies on team A’s service heavily. They are releasing soon and need to create release documentation; so they decide to use the same method that Team A is using.
+## End Point Analysis Integration Diagram
+
-Now there’s a problem; there are two teams with two separate sets of documentation. Some of it is manual and some of it is automated. This can cause problems for multiple reasons;
-1. Manually written parts might need to be repeated and might fall out of sync across the two sources
-2. If manually written documentation isn't repeated then the representation of their dependency is limited by a hyperlink to Team A's documentation without fully integrating
-3. The decoupling of documentation and code means that the documentation is most likely going to fall out of date
-4. Because there’s no persistence between team A’s documentation and Team B; if team A make a very specific change it likely won’t show in team B’s documentation
-
-This is what sysl-catalog is trying to solve
-
-sysl-catalog uses the sysl language as an intermediary between different formats to be able to generate different views of how services work
-
-### What is sysl?
-[Sysl](http://sysl.io/) is a “system specification language”; think of it like swagger or protos, but a much higher level, and with the ability to represent not only types, applications and endpoints, but interactions between those applications and endpoints; it plans to define what the code does itself.
-
-### What does sysl-catalog do?
-
-Sysl-catalog is just a static site generator.
-
-Sysl-catalog parses a sysl file (with the .sysl extension) and represents it in a visual form;
-It can represent endpoints (in sequence diagrams) request/response types or database tables, as well as integration diagrams.
-
-It uses go's `text/template` to do this, and if any addition is needed to be made, custom templates can be used (see `templates` for examples)
-
-## Installation
-
-#### go
-```bash
-go get -u -v github.com/anz-bank/sysl-catalog
-```
-
-#### docker
-- only recommended for `--serve` mode
-```bash
-docker run --rm -p 6900:6900 -v $(pwd):/usr/:ro anzbank/sysl-catalog:latest input.sysl --serve
-```
-
-#### docker-compose
-- see (demos)[demo/protos] for full example that includes .proto files
-```yaml
-version: '3.8'
-
-services:
- plantuml-server:
- image: plantuml/plantuml-server:tomcat-v1.2020.13
- ports:
- - 8080:8080
- protoc-gen-sysl:
- image: anzbank/protoc-gen-sysl:latest
- volumes:
- - ./:/usr/files
- working_dir: /usr/
- entrypoint: ["protoc", "--sysl_out=.", "files/simple.proto"]
- sysl-catalog:
- image: anzbank/sysl-catalog:latest
- volumes:
- - ./:/usr/
- environment:
- - SYSL_PLANTUML=http://plantuml-server:8080
- entrypoint: ["sysl-catalog", "-o", "docs", "project.sysl", "--imageDest", "docs/images"]
- depends_on:
- - plantuml-server
- - protoc-gen-sysl
-```
-
-
-## How to use
-1. Set up environment
-`export SYSL_PLANTUML=http://www.plantuml.com/plantuml`
-
-2. Run
-
-```bashs
-sysl-catalog -o