jolielang/docs
Jolie documentation
100K+
This repository manages the Jolie documentation at https://docs.jolie-lang.org/.
If you want to update the documentation, this is not the repository that you are looking for. You have to update the branch of this repository for the relevant version of Jolie, e.g., for Jolie versions 1.10.x
, you have to update the branch v1.10.x
.
Try to write the message request using inline syntax whenever possible. Ex:
readFile@file( { filename = "test.txt" } )( response )
instead of
request.filename = "test.txt"
readFile@File( request )( response )
Use multiple lines if necessary
writeFile@File( {
filename = "text.txt"
content = "this is a test message"
} )()
Use deep copy or with in case the request message has several nodes
request << {
node1 = "node1"
node2 = "node2"
node3 = "node3"
...
}
or
with( request ) {
node1 = "node1";
node2 = "node2";
node3 = "node3";
...
}
tutorials/fix/name-of-the-tutorial
tutorials/new/short-tutorial-name
jolie/examples
tutorials/new/short-tutorial-name
tutorials/new/short-tutorial-name
examples/v1.10.x/tutorials/
mkdir short-tutorial-name
examples/v1.10.x/tutorials/short-tutorial-name
jolie/docs
v.1.10.x
tutorials/new/short-tutorial-name
tutorials/new/short-tutorial-name
docs/web/tutorials/
mkdir short-tutorial-name
docs/web/tutorials/short-tutorial-name
README.md
as starting file for the tutorial. Start to write down the tutorial in this file
examples/v1.10.x/tutorials/short-tutorial-name
docs/src/images/
Segoe Print
for commentsfree hand lines
(setting bevel effect around 50) for tracing arrows for connecting comments and drawingsdocs/src/images/
(it is the source)docs/web/assets/

docs/web/SUMMARY.md
and place the link of your tutorial under main item Tutorial
. Tru to find a correct placement of the tutorial considering the fact the previous tutorials must give the minimal knowledge necessary to understand our tutorialdocker pull jolielang/docs