Skip to content
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

Replace links and references to Template Studio with Template Playground #422

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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: 2 additions & 2 deletions docs/accordproject-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ The Accord Project Community is developing several working groups focusing on di

A primary purpose of the working groups is to develop a universally accessible and widely used open source library of modular, smart legal contracts, smart templates and models that reflect input from the community. Smart legal contract templates are built according to the Project’s [Cicero Specification](https://github.com/accordproject/cicero).

Members can provide feedback into the templates and models relevant to a particular working group. You can immediately start contributing smart legal contract templates and models by using the Accord Project’s [Template Studio](https://studio.accordproject.org/).
Members can provide feedback into the templates and models relevant to a particular working group. You can immediately start contributing smart legal contract templates and models by using the Accord Project’s [Template Playground](https://playground.accordproject.org/).

The Accord Project has developed an easy-to-use programming language for building and executing smart legal contracts called Ergo. The goals of Ergo are to be accessible and usable by non-technical professionals, portable across, and compatible with, a variety of environments such as SaaS platforms and different blockchains, and meeting security, safety, and other requirements.

You can use the Accord Project’s [Template Studio](https://studio.accordproject.org/) to create and test your smart legal contracts.
You can use the Accord Project’s [Template Playground](https://playground.accordproject.org/) to create and test your smart legal contracts.

2 changes: 1 addition & 1 deletion docs/accordproject-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ Let's look at each component of the template triangle, starting with the text.

### What next?

Build your first smart legal contract templates, either [online](tutorial-studio.md) with Template Studio, or by [installing Cicero](started-installation.md).
Build your first smart legal contract templates, either [online](tutorial-studio.md) with Template Playground, or by [installing Cicero](started-installation.md).

Explore [sample templates](started-resources.md) and other resources in the rest of this documentation.

Expand Down
18 changes: 9 additions & 9 deletions docs/accordproject-tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,29 @@ id: accordproject-tour
title: Online Tour
---

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://studio.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://studio.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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably just remove this page entirely since it is focused on an outdated video.


<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
Expand Down
2 changes: 1 addition & 1 deletion docs/started-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,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
6 changes: 3 additions & 3 deletions docs/tutorial-studio.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
id: tutorial-studio
title: With Template Studio
title: With Template Playground
---

This tutorial will walk you through the steps of editing a clause template in [Template Studio](https://studio.accordproject.org/).
This tutorial will walk you through the steps of editing a clause template in [Template Playground](https://playground.accordproject.org/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tutorial can also be removed. We'll want to create a new one at a later date for the playground.


We start with a very simple _Late Penalty and Delivery_ Clause and gradually make it more complex, adding both legal text to it and the corresponding business logic in Ergo.

## Initial Late Delivery Clause

### Load the Template

To get started, head to the `minilatedeliveryandpenalty` template in the Accord Project Template Library at [Mini Late Delivery And Penalty](https://templates.accordproject.org/minilatedeliveryandpenalty@0.6.0.html) and click the "Open In Template Studio" button.
To get started, head to the `minilatedeliveryandpenalty` template in the Accord Project Template Library at [Mini Late Delivery And Penalty](https://templates.accordproject.org/minilatedeliveryandpenalty@0.6.0.html) and click the "Open In Template Playground" button.

![Advanced-Late-1](assets/advanced/late1.png)

Expand Down
10 changes: 5 additions & 5 deletions website/i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
"title": "With Node.js"
},
"tutorial-studio": {
"title": "With Template Studio"
"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 All @@ -171,7 +171,7 @@
"title": "Deploying on Hyperledger Fabric"
},
"version-0.12/version-0.12-advanced-latedelivery": {
"title": "Authoring in Template Studio"
"title": "Authoring in Template Playground"
},
"version-0.12/version-0.12-advanced-nodejs": {
"title": "Working with Node.js"
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">Template Playground</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
4 changes: 2 additions & 2 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
title: Template Playground
original_id: accordproject-studio
---

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

![Model Repository](/img/studio.png)
4 changes: 2 additions & 2 deletions website/versioned_docs/version-0.12/accordproject-tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ A simple VIM mode for Ergo can be found in the [ergo.vim](https://github.com/acc

> Those are not maintained as actively as the rest of the Accord Project. If you know emacs lisp or are a VIM user and would like to contribute, please contact us on the Accord Project Slack or directly through GitHub!

## Template Studio
## Template Playground

Finally, [Template Studio](https://studio.accordproject.org) lets you create, edit and test legal clause or contract templates built with the Accord Project directly from your browser, without having to install anything.
Finally, [Template Playground](https://studio.accordproject.org) lets you create, edit and test legal clause or contract templates built with the Accord Project directly from your browser, without having to install anything.

![Model Repository](/img/studio.png)
6 changes: 3 additions & 3 deletions website/versioned_docs/version-0.12/accordproject.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Beyond a core technology for executable legal templates, Accord Project is build

Several tools are also available to facilitate authoring of Accord Project templates:

- [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 Plugin](https://marketplace.visualstudio.com/items?itemName=accordproject.accordproject-vscode-plugin): an Accord Project extension to the popular [Visual Studio Code](https://visualstudio.microsoft.com/)

## Open Source Community
Expand All @@ -78,9 +78,9 @@ Join the Accord Project Technology Working Group <a href="https://docs.google.co

## Try Accord Project Online

The simplest way to get an introduction to the Accord Project technology is through the online [Template Studio](https://studio.accordproject.org) editor (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).
The simplest way to get an introduction to the Accord Project technology is through the online [Template Playground](https://studio.accordproject.org) editor (you can open Template Playground from anywhere in this documentation by clicking the [Try Online!](https://studio.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>

Expand Down
16 changes: 8 additions & 8 deletions website/versioned_docs/version-0.12/advanced-hyperledger.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ 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.

Expand All @@ -73,9 +73,9 @@ Once you've connected to your system, open https://studio.accordproject.org in a
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.
> In the Template Playground search bar, type **supplyagreement-perishable-goods**. Select the 0.12.1 version.

Explore the source components of the template.

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 Template Playground.

For example:
```json
Expand All @@ -123,7 +123,7 @@ For example:
}
```

Finally, create a `contract.txt` file with the contents of the Test Contract box from the Contract Text page in Template Studio.
Finally, create a `contract.txt` file with the contents of the Test Contract box from the Contract Text page in Template Playground.

:::note
It's important that your sample contract text exactly matches your grammar's structure, this includes trailing spaces and line breaks. To be sure that you copy everything, right click the window and choose Select All, before choosing Copy.
Expand Down Expand Up @@ -233,7 +233,7 @@ Take a look at some of the other stateful Cicero Templates to see what changes y
If you get really stuck, a solution is available for you to [download](https://drive.google.com/file/d/1cak_P_x01w8dz43aZX8N16G5DUNp6VbG/view?usp=sharing).
:::
2. Explore the source code of the Cicero chaincode shim that transforms your requests and deployments into Fabric transactions using the Fabric Node SDK. https://github.com/clauseHQ/fabric-samples/tree/master/chaincode/cicero
3. Create your own template from scratch using [Template Studio](https://studio.accordproject.org/), or download the [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=accordproject.accordproject-vscode-plugin).
3. Create your own template from scratch using [Template Playground](https://playground.accordproject.org/), or download the [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=accordproject.accordproject-vscode-plugin).
![Change Test Contract](assets/advanced/hlf4.png)
> A separate tutorial for creating a template using the Cicero CLI tool can be found in [Creating a New Template](basic-create).

Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-0.12/advanced-latedelivery.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
id: version-0.12-advanced-latedelivery
title: Authoring in Template Studio
title: Authoring in Template Playground
original_id: advanced-latedelivery
---

This tutorial will walk you through the steps of authoring a clause template in [Template Studio](https://studio.accordproject.org/).
This tutorial will walk you through the steps of authoring a clause template in [Template Playground](https://playground.accordproject.org/).

We start with a very simple _Late Penalty and Delivery_ Clause and gradually make it more complex, adding both legal text to it and the corresponding business logic in Ergo.

## Initial Late Delivery Clause

### Load the Template

To get started, head to the `minilatedeliveryandpenalty` template in the Accord Project Template Library at https://templates.accordproject.org/minilatedeliveryandpenalty@0.2.1.html and click the "Open In Template Studio" button.
To get started, head to the `minilatedeliveryandpenalty` template in the Accord Project Template Library at https://templates.accordproject.org/minilatedeliveryandpenalty@0.2.1.html and click the "Open In Template Playground" button.

![Advanced-Late-1](assets/advanced/late1.png)

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 Template Playground](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.
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ _More information about Ergo can be found in the [Ergo Logic](logic-ergo) Sectio

## What next?

Build your first smart legal contract templates, either [online](tutorial-latedelivery) with Template Studio, or by [installing Cicero](started-installation).
Build your first smart legal contract templates, either [online](tutorial-latedelivery) with Template Playground, or by [installing Cicero](started-installation).

Explore [sample templates](started-resources) and other resources in the rest of this documentation.

Expand Down
Loading