{"id":46089234,"url":"https://github.com/jolie/docs","last_synced_at":"2026-03-01T17:16:11.005Z","repository":{"id":9805410,"uuid":"63398678","full_name":"jolie/docs","owner":"jolie","description":"The Jolie Documentation files","archived":false,"fork":false,"pushed_at":"2026-02-19T09:18:05.000Z","size":8842,"stargazers_count":6,"open_issues_count":1,"forks_count":23,"subscribers_count":12,"default_branch":"master","last_synced_at":"2026-02-19T14:18:58.322Z","etag":null,"topics":["documentation","gitbook","jolie"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jolie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-07-15T06:48:41.000Z","updated_at":"2026-02-19T09:17:14.000Z","dependencies_parsed_at":"2024-02-04T16:14:11.524Z","dependency_job_id":"0b541aa3-14c0-4659-b175-49e95fcec43b","html_url":"https://github.com/jolie/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jolie/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jolie%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jolie%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jolie%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jolie%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jolie","download_url":"https://codeload.github.com/jolie/docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jolie%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29976273,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T16:35:47.903Z","status":"ssl_error","status_checked_at":"2026-03-01T16:35:44.899Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","gitbook","jolie"],"created_at":"2026-03-01T17:16:10.467Z","updated_at":"2026-03-01T17:16:10.998Z","avatar_url":"https://github.com/jolie.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# The Jolie Documentation repository\n\nThis repository manages the Jolie documentation at \u003chttps://docs.jolie-lang.org/\u003e.\n\nIf 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`.\n\n## How to contribute to the documentation\n\n## Guidelines for creating examples\n\n### Naming conventions\n\n- outputPort: camelCase\n    - location: camelCase\n    - protocol: camelCase\n    - interfaces: camelCase\n    - aggregates: camelCase\n    - redirects: camelCase\n    - RequestResponse: CamelCase\n    - OneWay: CamelCase\n- inputPort: camelCase\n    - location: camelCase\n    - protocol: camelCase\n    - interfaces: camelCase\n    - aggregates: camelCase\n    - redirects: camelCase\n    - RequestResponse: CamelCase\n    - OneWay: CamelCase\n- ServiceName: CamelCase\n- TypeName: CamelCase\n- Interfaces: CamelCase\n    - RequestResponse: CamelCase\n    - OneWay: CamelCase\n- operations: camelCase\n- variables: camelCase\n- package-name: kebab-case\n- module-name: kebab-case\n- CONSTANTS: SCREAMING_SNAKE_CASE\n- define: camelCase\n- private: camelCase\n\n### Request message assignment\n\n- Try to write the message request using inline syntax whenever possible.\n  Ex:\n\n  ```jolie\n  readFile@file( { filename = \"test.txt\" } )( response )\n  ```\n\n  instead of\n\n  ```jolie\n  request.filename = \"test.txt\"\n  readFile@File( request )( response )\n  ```\n  \n- Use multiple lines if necessary\n\n  ```jolie\n  writeFile@File( {\n  filename = \"text.txt\"\n  content = \"this is a test message\"\n  } )()\n  ```\n\n- Use deep copy or with in case the request message has several nodes\n  \n```jolie\nrequest \u003c\u003c {\n    node1 = \"node1\"\n    node2 = \"node2\"\n    node3 = \"node3\"\n    ...\n}\n```\n  \nor\n  \n```jolie\nwith( request ) {\n    node1 = \"node1\";\n    node2 = \"node2\";\n    node3 = \"node3\";\n    ...\n}\n```\n\n## Fixing a tutorial\n\n- Create a branch named as it follows\n    - `tutorials/fix/name-of-the-tutorial`\n\n## Creating a new tutorial\n\n- Define a branch name that follows this guideline `tutorials/new/short-tutorial-name`\n- Actions to take in repo `jolie/examples` \n    - Create a branch with the name `tutorials/new/short-tutorial-name`\n    - Checkout branch `tutorials/new/short-tutorial-name`\n    - Go to folder `examples/v1.10.x/tutorials/`\n    - Create a directory with the short name of the tutorial `mkdir short-tutorial-name`\n    - Go to folder `examples/v1.10.x/tutorials/short-tutorial-name`\n    - Create all the files necessary for the tutorial\n    - Commit\n- Actions to take in repo `jolie/docs`\n    - Checkout branch `v.1.10.x`\n    - Starting from this branch create a new branch `tutorials/new/short-tutorial-name`\n    - Checkout branch `tutorials/new/short-tutorial-name`\n    - Go to folder `docs/web/tutorials/`\n    - Create a directory with the short name of the tutorial `mkdir short-tutorial-name`\n    - Go to folder `docs/web/tutorials/short-tutorial-name`\n    - Create file `README.md` as starting file for the tutorial. Start to write down the tutorial in this file\n        - Remember to add links to the examples previously created in `examples/v1.10.x/tutorials/short-tutorial-name`\n        - if you need to add links to other existing pages of the docs, please insert the URL of the page, not the path\n        - If you need to add images:\n            - Go into folder `docs/src/images/`\n            - Select a .svg file which is close to the diagram you want to create\n            - Open the file with the open version of [inkscape](https://inkscape.org/)  \n            - Copy the file into a new file, giving it a new filename\n            - Close the file and open the new one, starting to editing it as you prefer\n                - Remember to use font `Segoe Print` for comments\n                - Remember to use tool `free hand lines` (setting bevel effect around 50) for tracing arrows for connecting comments and drawings\n                - Remember to use squared lines for connecting microservices together\n            - Once edited:\n                - Save the .svg file into folder `docs/src/images/` (it is the source)\n                - Save the .png file into folder `docs/web/assets/`\n                - Create a link in the doc to png file. Example of a link:\n                    - `![](https://raw.githubusercontent.com/jolie/docs/v1.10.x/web/.gitbook/assets/using_dependencies_01.png)`\n    - Once edited the documentation, open file `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 tutorial\n- Open a pull request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjolie%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjolie%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjolie%2Fdocs/lists"}