Skip to content

Commit

Permalink
Changed product names in the documentation (digital-asset#12668)
Browse files Browse the repository at this point in the history
* Changes to product names

CHANGELOG_BEGIN
CHANGELOG_END

Terminology changes made:
- Removing reference to 'Connect'
- Changing the product names

* Update docs/source/support/overview.rst

Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>

* Update docs/source/getting-started/installation.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/ops/connect/auth0.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/ops/connect/auth0.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/ops/connect/helm.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/ops/connect/helm.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/ops/connect/index.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/support/compatibility.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/support/compatibility.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

* Update docs/source/tools/trigger-service/auth0_example.rst

Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>

Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
Co-authored-by: Stefano Baghino <43749967+stefanobaghino-da@users.noreply.github.com>
  • Loading branch information
3 people authored Feb 1, 2022
1 parent 5caaf1f commit b4ed15b
Show file tree
Hide file tree
Showing 28 changed files with 104 additions and 105 deletions.
2 changes: 1 addition & 1 deletion docs/source/app-dev/bindings-java/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,7 @@ Integrate with the ledger

A distributed ledger only forms the core of a full Daml application.

To build automations and integrations around the ledger, Daml Connect has :doc:`language bindings </app-dev/bindings-java/index>` for the Ledger API in several programming languages.
To build automations and integrations around the ledger, Daml has :doc:`language bindings </app-dev/bindings-java/index>` for the Ledger API in several programming languages.


To compile the Java integration for the quickstart application, we first need to run the Java codegen on the DAR we built before::
Expand Down
2 changes: 1 addition & 1 deletion docs/source/app-dev/command-deduplication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Independently of how the outcome is communicated, command deduplication generate

For deduplication to work as intended, all submissions for the same ledger change must be submitted via the same participant.
Whether a submission is considered a duplicate is determined by completion events, and by default a participant outputs only the completion events for submissions that were requested via the very same participant.
At this time, only `Daml Driver for VMware Blockchain <https://www.digitalasset.com/daml-for-vmware-blockchain/>`__ supports command deduplication across participants.
At this time, only `Daml driver for VMware Blockchain <https://www.digitalasset.com/daml-for-vmware-blockchain/>`__ supports command deduplication across participants.

.. _command-dedup-usage:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/daml/daml-studio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Daml Studio is an integrated development environment (IDE) for Daml. It is an ex
Installing
**********

Daml Studio is included in :doc:`the Daml Connect SDK </getting-started/installation>`.
Daml Studio is included in :doc:`the Daml SDK </getting-started/installation>`.

Creating your first Daml file
*****************************
Expand Down
4 changes: 2 additions & 2 deletions docs/source/daml/intro/0_Intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ An introduction to Daml

Daml is a smart contract language designed to build composable applications on an abstract :ref:`da-ledgers`.

In this introduction, you will learn about the structure of a Daml Ledger, and how to write Daml applications that run on any Daml Ledger implementation, by building an asset-holding and -trading application. You will gain an overview over most important language features, how they relate to the :ref:`da-ledgers` and how to use Daml Connect's developer tools to write, test, compile, package and ship your application.
In this introduction, you will learn about the structure of a Daml Ledger, and how to write Daml applications that run on any Daml Ledger implementation, by building an asset-holding and -trading application. You will gain an overview over most important language features, how they relate to the :ref:`da-ledgers` and how to use Daml's developer tools to write, test, compile, package and ship your application.

This introduction is structured such that each section presents a new self-contained application with more functionality than that from the previous section. You can find the Daml code for each section `here <https://github.com/digital-asset/daml/tree/main/docs/source/daml/intro/daml>`_ or download them using the Daml assistant. For example, to load the sources for section 1 into a folder called ``1_Token``, run ``daml new 1_Token --template daml-intro-1``.

Prerequisites:

- You have installed the :doc:`Daml Connect SDK </getting-started/installation>`
- You have installed the :doc:`Daml SDK </getting-started/installation>`

Next: :doc:`1_Token`.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/deploy/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ for production use today.
* - Product
- Ledger
- Vendor
* - `Daml Driver for VMware Blockchain <https://www.digitalasset.com/daml-for-vmware-blockchain/>`__
* - `Daml driver for VMware Blockchain <https://www.digitalasset.com/daml-for-vmware-blockchain/>`__
- `VMware Blockchain <https://www.vmware.com/products/blockchain.html/>`__
- `VMware <https://vmware.com/>`__
* - `Daml on Corda <#>`__
Expand Down Expand Up @@ -64,7 +64,7 @@ The following table lists open source Daml integrations.
- `Github Repo <https://github.com/digital-asset/daml-on-fabric>`__
* - `PostgreSQL <https://www.postgresql.org/>`__
- `Digital Asset <https://digitalasset.com/>`__
- `Daml Driver for PostgreSQL Docs <https://docs.daml.com/daml-driver-for-postgresql/>`__
- `Daml driver for PostgreSQL Docs <https://docs.daml.com/daml-driver-for-postgresql/>`__

.. _deploy-ref_in_development:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting-started/app-architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ In your terminal, navigate to the root ``create-daml-app`` directory and run::
daml studio

This should open the Visual Studio Code editor at the root of the project.
(You may get a new tab pop up with release notes for the latest version of Daml Connect - just close this.)
(You may get a new tab pop up with release notes for the latest version of Daml - just close this.)
Using the file *Explorer* on the left sidebar, navigate to the ``daml`` folder and double-click on the ``User.daml`` file.

The Daml code defines the *data* and *workflow* of the application.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ With that, let's get started!
Prerequisites
*************

Please make sure that you have the Daml Connect SDK, Java 8 or higher, and Visual Studio Code (the only supported IDE) installed as per instructions from our :doc:`installation` page.
Please make sure that you have the Daml SDK, Java 8 or higher, and Visual Studio Code (the only supported IDE) installed as per instructions from our :doc:`installation` page.

You will also need some common software tools to build and interact with the template project.

Expand Down
10 changes: 5 additions & 5 deletions docs/source/getting-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installing the SDK
1. Install the dependencies
***************************

The Daml Connect SDK currently runs on Windows, macOS and Linux.
The Daml SDK currently runs on Windows, macOS and Linux.

You need to install:

Expand Down Expand Up @@ -38,10 +38,10 @@ To install the SDK on Mac or Linux open a terminal and run:
The installer will setup the ``PATH`` variable for you. In order for it to take effect, you will have to
log out and log in again.

Installing the Enterprise Edition
*********************************
Installing Daml Enterprise
**************************

If you have a license for the enterprise edition of Daml Connect, you
If you have a license for Daml Enterprise, you
can install it as follows:

On Windows, download the installer from Artifactory_ instead of Github
Expand All @@ -59,7 +59,7 @@ This will be used by the assistant to download other versions automatically from

If you already have an existing installation, you only need to add
this entry to ``daml-config.yaml``. To overwrite a previously
installed version with the corresponding enterprise edition, use
installed version with the corresponding Daml Enterprise version, use
``daml install --force VERSION``.

Next steps
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting-started/manual-download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Manually installing the SDK
***************************

If you require a higher level of security, you can instead install the Daml Connect SDK by manually downloading the compressed tarball, verifying its signature, extracting it and manually running the install script.
If you require a higher level of security, you can instead install the Daml SDK by manually downloading the compressed tarball, verifying its signature, extracting it and manually running the install script.

Note that the Windows installer is already signed (within the binary itself), and that signature is checked by Windows before starting it. Nevertheless, you can still follow the steps below to check its external signature file.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/json-api/production-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ query performance. Details for enabling a query store are highlighted below.
Query store
***********

.. note:: The Community Edition of Daml Connect only supports PostgreSQL backends for the *HTTP JSON API* server, but the Enterprise Edition also supports Oracle backends.
.. note:: Daml Open Source only supports PostgreSQL backends for the *HTTP JSON API* server, but Daml Enterprise also supports Oracle backends.

The query store is a cached search index and is useful for use cases
where the application needs to query large active contract sets (ACS). The *HTTP JSON API* server can be
configured with PostgreSQL/Oracle (Enterprise Edition only) as the query store backend.
configured with PostgreSQL/Oracle (Daml Enterprise only) as the query store backend.

The query store is built by saving the state of the ACS up to the current ledger
offset. This allows the *HTTP JSON API* to only request the delta on subsequent queries,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/json-api/search-query-language.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Appendix: Known issues
When using Oracle, queries fail if a token is too large
=======================================================

This limitation is exclusive to users of the HTTP JSON API using the Enterprise Edition support for Oracle. Due to a known limitation in Oracle, the full-test JSON search index on the contract payloads rejects query tokens larger than 256 bytes. This limitations shouldn't impact most workloads, but if this needs to be worked around, the HTTP JSON API server can be started passing the additional ``disableContractPayloadIndexing=true`` (after wiping an existing query store database, if necessary).
This limitation is exclusive to users of the HTTP JSON API using Daml Enterprise support for Oracle. Due to a known limitation in Oracle, the full-test JSON search index on the contract payloads rejects query tokens larger than 256 bytes. This limitations shouldn't impact most workloads, but if this needs to be worked around, the HTTP JSON API server can be started passing the additional ``disableContractPayloadIndexing=true`` (after wiping an existing query store database, if necessary).

`Issue on GitHub <https://github.com/digital-asset/daml/issues/10780>`__

19 changes: 9 additions & 10 deletions docs/source/ops/connect/auth0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Setting Up Auth0
================

In this section, we will walk through a complete setup of an entire Daml
Connect system using Auth0 as its authentication provider.
system using Auth0 as its authentication provider.

.. note::

Expand Down Expand Up @@ -65,7 +65,7 @@ In order to follow along this guide, you will need:
- An application you want to deploy on your Daml system. This is not, strictly
speaking, required, but the whole experience is going to be a lot less
satisfying if you don't end up with something actually running on your Daml
Connect system. In this guide, we'll use the `create-daml-app` template,
system. In this guide, we'll use the `create-daml-app` template,
which as of Daml SDK 1.17.0 supports Auth0 out-of-the-box on its UI side.

Generating Party Allocation Credentials
Expand Down Expand Up @@ -593,17 +593,16 @@ in the folder that contains both ``nginx`` and ``my-project``:
And that's it for building the application. We now have a DAR file that is
ready to be deployed to a ledger, as well as a Docker container ready to serve
our frontend. All we need now is to get a Daml Connect system up and running.
our frontend. All we need now is to get a Daml system up and running.
We document two paths forward here: one that relies on the Helm chart included
in Daml Connect Enterprise Edition, and a manual setup using only the Community
Edition SDK.
in Daml Enterprise, and a manual setup using only the Open Source SDK.
Using the Connect Helm Chart
****************************
Using the Daml Helm Chart
*************************
For simplicity, we assume that you have access to a server with a public IP
address that both you and Auth0 can reach. Furthermore, we assume that you have
access to Enterprise Edition credentials to download the Docker images. We
access to Daml Enterprise credentials to download the Docker images. We
also assume you can create a local cluster with ``minikube`` on the remote
machine. Finally, we assume that you have downloaded the Helm chart in a folder
called ``daml-connect``.
Expand Down Expand Up @@ -673,8 +672,8 @@ domain on which your server is exposed. And voilà! Your application is up and
running. You should be able to log in with Auth0, exchange messages, and set up
an auto-reply trigger, all by connecting your browser to ``https://$DOMAIN/``.
Manually Setting Up the Connect Components
******************************************
Manually Setting Up the Daml Components
***************************************
For simplicity, we assume that all of the Daml components will run on a single
machine (they can find each other on ``localhost``) and that this machine has
Expand Down
Loading

0 comments on commit b4ed15b

Please sign in to comment.