Skip to content

Feature: Studio to playground #462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/accordproject-faq.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---

---
****
---
id: accordproject-faq
title: FAQ
---
Expand Down
3 changes: 3 additions & 0 deletions docs/accordproject-template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
---

---
****---
id: accordproject-template
title: Accord Project Templates
---
Expand Down
23 changes: 11 additions & 12 deletions docs/accordproject-tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,29 @@ id: accordproject-tour
title: Online Tour
---

To get better acquainted with Accord Project templates, the easiest way is through the online [Template Studio](https://studio.accordproject.org) editor.
To get better acquainted with Accord Project templates, the easiest way is through the online [Template Playground](https://playground.accordproject.org) editor.

:::tip
You can open template studio from anywhere in this documentation by clicking the [Try Online!](https://studio.accordproject.org) button located in the top-right of the page.
You can open template playground from anywhere in this documentation by clicking the [Try Online!](<https://playground.accordproject.org/) button located in the top-right of the page.
:::

The following video offers a tour of Template Studio and an introduction to the key concepts behind the Accord Project technology.

The following video offers a tour of Template playground and an introduction to the key concepts behind the Accord Project technology.
<!--
<iframe src="https://player.vimeo.com/video/328933628" width="640" height="400" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>

Here is a timestamp of what is covered in the video:

- **00:08** : Introduction to template Studio & pointers the other parts of the docs / AP website
- **00:08** : Introduction to template playground & pointers the other parts of the docs / AP website
- **03:51** : Helloworld template tutorial start
- **04:48** : Template Studio - Metadata
- **06:56** : Template Studio - Contract Text
- **04:48** : Template Playground - Metadata
- **06:56** : Template Playground - Contract Text
- **07:52** : The 'live' nature of the text; how to read errors
- **08:39** : Changing the template text itself
- **09:17** : Changing the variables in the template text
- **10:00** : Template Studio - Model update
- **11:28** : Template Studio - Logic update
- **10:00** : Template Playground - Model update
- **11:28** : Template Playground - Logic update
- **13:17** : Explanation about request types / response types
- **14:44** : Template Studio - Logic - Test Execution (request, response)
- **14:44** : Template Playground - Logic - Test Execution (request, response)
- **15:57** : Test Execution - contract state
- **16:49** : Test Execution - obligations
- **18:20** : Wrap-up

- **18:20** : Wrap-up -->
498 changes: 249 additions & 249 deletions docs/ergo-tutorial.md

Large diffs are not rendered by default.

542 changes: 271 additions & 271 deletions docs/tutorial-studio.md → docs/tutorial-playground.md

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions website/i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
"tagline": "Documentation",
"docs": {
"accordproject-faq": {
"title": "FAQ"
"title": "accordproject-faq"
},
"accordproject-slc": {
"title": "Smart Legal Contracts"
},
"accordproject-template": {
"title": "Accord Project Templates"
"title": "accordproject-template"
},
"accordproject-tour": {
"title": "Online Tour"
Expand Down Expand Up @@ -137,8 +137,8 @@
"tutorial-nodejs": {
"title": "With Node.js"
},
"tutorial-studio": {
"title": "With Template Studio"
"tutorial-playground": {
"title": "With Template playground"
},
"tutorial-templates": {
"title": "Templates Deep Dive"
Expand All @@ -156,7 +156,7 @@
"title": "Learning Resources"
},
"version-0.12/version-0.12-accordproject-studio": {
"title": "Template Studio"
"title": "Template Playground"
},
"version-0.12/version-0.12-accordproject-templates": {
"title": "Open Source Templates"
Expand Down Expand Up @@ -588,7 +588,7 @@
"title": "With Node.js"
},
"version-0.21/version-0.21-tutorial-studio": {
"title": "With Template Studio"
"title": "With Template Playground"
},
"version-0.21/version-0.21-tutorial-templates": {
"title": "Templates Deep Dive"
Expand Down Expand Up @@ -633,7 +633,7 @@
"title": "With Node.js"
},
"version-0.22/version-0.22-tutorial-studio": {
"title": "With Template Studio"
"title": "With Template Playground"
},
"version-0.22/version-0.22-tutorial-templates": {
"title": "Templates Deep Dive"
Expand Down
2 changes: 1 addition & 1 deletion website/pages/en/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ const TryOut = props => (
{[
{
content:
'<div class="typeset">You can author and test templates online in the Accord Project <a href="https://studio.accordproject.org">Template Studio</a>. Search for existing templates, edit the contract text and execute the logic.</div>',
'<div class="typeset">You can author and test templates online in the Accord Project <a href="https://studio.accordproject.org"></a>. Search for existing templates, edit the contract text and execute the logic.</div>',
image: imgUrl("../docs/assets/020/studio.png"),
imageAlt:
"An example a template being edited. There is an option to edit the full contract or a single clause. There is also a search bar at the top center for users to search for specific templates.",
Expand Down
53 changes: 24 additions & 29 deletions website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,73 +4,68 @@
"Getting Started": ["started-installation", "started-hello", "started-resources"],
"Template Guides": [
{
"type": "subcategory",
"type": "category",
"label": "Markdown Text",
"ids": ["markup-preliminaries", "markup-commonmark", "markup-ciceromark", "markup-templatemark"]
"items": ["markup-preliminaries", "markup-commonmark", "markup-ciceromark", "markup-templatemark"]
},
{
"type": "subcategory",
"label": "Concerto Model",
"ids": ["model-concerto", "model-vocabulary", "model-namespaces", "model-classes", "model-enums", "model-properties", "model-relationships", "model-decorators", "model-api"]
},
{
"type": "subcategory",
"type": "category",
"label": "Ergo Logic",
"ids": ["logic-ergo", "logic-simple-expr", "logic-simple-type", "logic-complex-type", "logic-advanced-expr", "logic-stmt", "logic-decl", "logic-module"]
"items": ["logic-ergo", "logic-simple-expr", "logic-simple-type", "logic-complex-type", "logic-advanced-expr", "logic-stmt", "logic-decl", "logic-module"]
}
],
"Tutorials": [
{
"type": "subcategory",
"type": "category",
"label": "Using Cicero",
"ids": ["tutorial-templates", "tutorial-library", "tutorial-create"]
"items": ["tutorial-templates", "tutorial-library", "tutorial-create"]
},
{
"type": "subcategory",
"type": "category",
"label": "Template Authoring",
"ids": ["tutorial-studio","tutorial-vscode"]
"items": ["tutorial-playground","tutorial-vscode"]
},
{
"type": "subcategory",
"type": "category",
"label": "Template Execution",
"ids": ["tutorial-nodejs", "tutorial-hyperledger"]
"items": ["tutorial-nodejs", "tutorial-hyperledger"]
}
],
"Reference Manual": [
{
"type": "subcategory",
"type": "category",
"label": "General",
"ids": ["ref-glossary", "ref-errors"]
"items": ["ref-glossary", "ref-errors"]
},
{
"type": "subcategory",
"type": "category",
"label": "Migration",
"ids": ["ref-migrate-0.13-0.20", "ref-migrate-0.20-0.21", "ref-migrate-0.21-0.22", "ref-migrate-concerto-0.82-1.0", "ref-migrate-concerto-1.0-2.0", "ref-migrate-concerto-2.0-3.0"]
"items": ["ref-migrate-0.13-0.20", "ref-migrate-0.20-0.21", "ref-migrate-0.21-0.22"]
},
{
"type": "subcategory",
"type": "category",
"label": "Cicero Reference",
"ids": ["ref-cicero-cli", "ref-cicero-api", "ref-cicero-testing"]
"items": ["ref-cicero-cli", "ref-cicero-api", "ref-cicero-testing"]
},
{
"type": "subcategory",
"type": "category",
"label": "Markdown Transform Reference",
"ids": ["ref-markus-cli"]
"items": ["ref-markus-cli"]
},
{
"type": "subcategory",
"type": "category",
"label": "Concerto Reference",
"ids": ["ref-concerto-decorators", "ref-concerto-cli", "ref-concerto-api"]
"items": ["ref-concerto-decorators", "ref-concerto-cli", "ref-concerto-api"]
},
{
"type": "subcategory",
"type": "category",
"label": "Ergo Reference",
"ids": ["ref-ergo-stdlib", "ref-ergo-cli", "ref-ergo-repl", "ref-ergo-api", "ref-ergo-spec"]
"items": ["ref-ergo-stdlib", "ref-ergo-cli", "ref-ergo-repl", "ref-ergo-api", "ref-ergo-spec"]
},
{
"type": "subcategory",
"type": "category",
"label": "Web Components Reference",
"ids": ["ref-web-components-overview"]
"items": ["ref-web-components-overview"]
}
]
}
Expand Down
2 changes: 1 addition & 1 deletion website/siteConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ const siteConfig = {
// For no header links in the top nav bar -> headerLinks: [],
headerLinks: [
{ doc: 'accordproject', label: 'Documentation' },
{ href: "https://studio.accordproject.org", label: "Try Online!"},
{ href: "https://playground.accordproject.org", label: "Try Online!"},
{ href: "https://github.com/accordproject", label: "GitHub" },
{ search: true },
],
Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-0.12/accordproject-studio.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: version-0.12-accordproject-studio
title: Template Studio
original_id: accordproject-studio
title: Template Playground
original_id: accordproject-playground
---

[Template Studio](https://studio.accordproject.org) lets you create, edit and test legal clause or contract templates built with the Accord Project.
[Template Studio](https://playground.accordproject.org) lets you create, edit and test legal clause or contract templates built with the Accord Project.

![Model Repository](/img/studio.png)
12 changes: 6 additions & 6 deletions website/versioned_docs/version-0.12/advanced-hyperledger.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,23 +57,23 @@ Once you've provisioned your server, install all of the required tools using the
- [Git](https://www.digitalocean.com/community/tutorials/how-to-install-git-on-ubuntu-18-04)
- [Fabric](https://hyperledger-fabric.readthedocs.io/en/release-1.3/getting_started.html)

## Create your Smart Legal Contract with Template Studio
## Create your Smart Legal Contract with Template Playground

Cicero Templates are the magic glue that binds your clever legal words with the logic that will run on your network. In this first step, we'll create a template in [Template Studio](https://studio.accordproject.org/).
Cicero Templates are the magic glue that binds your clever legal words with the logic that will run on your network. In this first step, we'll create a template in [Template Playground](https://playground.accordproject.org/).

Template Studio is a browser-based development environment for Cicero Templates. Your templates are only every stored in your browser (and are not shared with the Accord Project), so you should **Export** your work to save it for another time.
Template Playground is a browser-based development environment for Cicero Templates. Your templates are only every stored in your browser (and are not shared with the Accord Project), so you should **Export** your work to save it for another time.

This tutorial uses the `supplyagreement-perishable-goods` template. This Smart Legal Agreement combines a plaintext contract for the shipment of goods that impose conditions on temperature and humidity until the shipment is delivered.

We simulate the submission of IoT events from sensors that get sent to the contract in a supply blockchain network. The contract determines the obligations and actions of the parties according to its logic and legal text.

Once you've connected to your system, open https://studio.accordproject.org in a new browser window.
Once you've connected to your system, open https://playground.accordproject.org in a new browser window.

:::note
In the hosted images, Mozilla Firefox is preinstalled, click the icon on the top-left toolbar to launch it.
:::

The Template Studio allows you to load sample templates for smart legal agreements from the [Accord Project template library](https://templates.accordproject.org/).
The Template Playground allows you to load sample templates for smart legal agreements from the [Accord Project template library](https://templates.accordproject.org/).

> In the Template Studio search bar, type **supplyagreement-perishable-goods**. Select the 0.12.1 version.

Expand All @@ -100,7 +100,7 @@ The _Obligations_ that are emitted by the contract are configured to be emitted

Save your CTA (Cicero Template Archive) file somewhere safe, as you'll need to use it in a later step. We suggest saving the file in user's the home folder.

> Create a `request.json` file with the contents of the **Request** box from the **Logic** -> **Test Execution** page in Template Studio.
> Create a `request.json` file with the contents of the **Request** box from the **Logic** -> **Test Execution** page in .

For example:
```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ If you are new to the Accord Project, the best place to start is our [Online Tou

If any of the technical terms are confusing or hard to understand, we have a [Glossary](ref-glossary) page that may help you. If there are any concepts or terms that you want to include in the Glossary, please join our [slack channel](https://accord-project-slack-signup.herokuapp.com/) and make suggestions!

If you want to create a template yourself, please see [Authoring in Template Studio](tutorial-latedelivery) for a step-by-step guide on how to create your first template. The tutorial will provide an accessible starting point for those without significant development experience to begin building smart legal contracts using the Accord Project technology.
If you want to create a template yourself, please see [Authoring in ](tutorial-latedelivery) for a step-by-step guide on how to create your first template. The tutorial will provide an accessible starting point for those without significant development experience to begin building smart legal contracts using the Accord Project technology.
2 changes: 1 addition & 1 deletion website/versioned_docs/version-0.20/ref-cicero-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ original_id: ref-cicero-ui

Accord Project publishes [React](https://reactjs.org) user interface components for use in web-applications. Please refer to the cicero-ui project [on GitHub](https://github.com/accordproject/cicero-ui) for detailed usage instructions.

You can preview these components in [Template Studio v2](https://accordproject-studio.netlify.com).
You can preview these components in [ v2](https://accordproject-studio.netlify.com).

![Template-Studio-V2](/docs/assets/reference/tsv2.png)

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-0.20/started-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Accord Project is also developing tools to help with authoring, testing and runn

### Editors

- [Template Studio](https://studio.accordproject.org/): a Web-based editor for Accord Project templates
- [Template Playground](https://playground.accordproject.org/): a Web-based editor for Accord Project templates
- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=accordproject.cicero-vscode-extension): an Accord Project extension to the popular [Visual Studio Code](https://visualstudio.microsoft.com/) Editor
- [Emacs Mode](https://github.com/accordproject/ergo/tree/master/ergo.emacs): Emacs Major mode for Ergo (alpha)
- [VIM Plugin](https://github.com/accordproject/ergo/tree/master/ergo.vim): VIM plugin for Ergo (alpha)
Expand Down
25 changes: 13 additions & 12 deletions website/versioned_docs/version-0.20/started-studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,34 @@ title: Online Tour
original_id: started-studio
---

To get an better acquainted with Accord Project templates, the easiest way is through the online [Template Studio](https://studio.accordproject.org) editor.
To get an better acquainted with Accord Project templates, the easiest way is through the online [Template Playground](https://playground.accordproject.org) editor.

:::tip
You can open template studio from anywhere in this documentation by clicking the [Try Online!](https://studio.accordproject.org) button located in the top-right of the page.
You can open Templaate Playground from anywhere in this documentation by clicking the [Try Online!](https://playground.accordproject.org) button located in the top-right of the page.
:::

The following video offers a tour of Template Studio and an introduction to the key concepts behind the Accord Project technology.
The following video offers a tour of Template Playground and an introduction to the key concepts behind the Accord Project technology.

<iframe src="https://player.vimeo.com/video/328933628" width="640" height="400" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>

<!--
Here is a timestamp of what is covered in the video:

- **00:08** : Introduction to template Studio & pointers the other parts of the docs / AP website
- **00:08** : Introduction to template Playground & pointers the other parts of the docs / AP website
- **03:51** : Helloworld template tutorial start
- **04:48** : Template Studio - Metadata
- **06:56** : Template Studio - Contract Text
- **04:48** : Template Playground - Metadata
- **06:56** : Template Playground - Contract Text
- **07:52** : The 'live' nature of the text; how to read errors
- **08:39** : Changing the template text itself
- **09:17** : Changing the variables in the template text
- **10:00** : Template Studio - Model update
- **11:28** : Template Studio - Logic update
- **10:00** : Template Playground - Model update
- **11:28** : Template Playground - Logic update
- **13:17** : Explanation about request types / response types
- **14:44** : Template Studio - Logic - Test Execution (request, response)
- **14:44** : Template Playground - Logic - Test Execution (request, response)
- **15:57** : Test Execution - contract state
- **16:49** : Test Execution - obligations
- **18:20** : Wrap-up

## What next?
-->
## What next?

Learn more about authoring Accord Project templates in template studio with the [Editing a Late Delivery Clause](tutorial-latedelivery) tutorial.
Learn more about authoring Accord Project templates in with the [Editing a Late Delivery Clause](tutorial-latedelivery) tutorial.
Loading