Relabel "Experimental" to "Early Access" and reorganise pages (digita…

…l-asset#5411) CHANGELOG_BEGIN - Move daml2ts, bindings-ts and JSON API out of experimental section in docs - Rename Experimental to Early Access in docs and assistant - Reorganise the docs a little bit to de-emphasise the Ledger API CHANGELOG_END
axman6 · Apr 3, 2020 · c496e2b · c496e2b
1 parent 62da572
commit c496e2b
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 67 deletions.
diff --git a/compiler/damlc/lib/DA/Cli/Damlc.hs b/compiler/damlc/lib/DA/Cli/Damlc.hs
@@ -219,14 +219,14 @@ cmdInspect =
 
 cmdVisual :: Mod CommandFields Command
 cmdVisual =
-    command "visual" $ info (helper <*> cmd) $ progDesc "Generate visual from dar" <> fullDesc
+    command "visual" $ info (helper <*> cmd) $ progDesc "Generate visual from dar (early access)" <> fullDesc
     where
       cmd = vis <$> inputDarOpt <*> dotFileOpt
       vis a b = Command Visual Nothing $ execVisual a b
 
 cmdVisualWeb :: Mod CommandFields Command
 cmdVisualWeb =
-    command "visual-web" $ info (helper <*> cmd) $ progDesc "Generate D3-Web Visual from dar" <> fullDesc
+    command "visual-web" $ info (helper <*> cmd) $ progDesc "Generate D3-Web Visual from dar (early access)" <> fullDesc
     where
       cmd = vis <$> inputDarOpt <*> htmlOutFile <*> openBrowser
       vis a b browser = Command Visual Nothing $ execVisualHtml a b browser

diff --git a/docs/configs/pdf/index.rst b/docs/configs/pdf/index.rst
@@ -12,7 +12,8 @@ Getting started
    :maxdepth: 2
 
    Installing the SDK <getting-started/installation>
-   Quickstart Guide <getting-started/quickstart>
+   getting-started/index
+   getting-started/testing
 
 Writing DAML
 ------------
@@ -36,15 +37,13 @@ Building applications
    :maxdepth: 2
 
    app-dev/app-arch
-   app-dev/authentication
-   app-dev/ledger-api
-   app-dev/bindings-java/index
-   app-dev/bindings-scala/index
-   app-dev/bindings-js
-   app-dev/grpc/index
-   app-dev/bindings-x-lang/index
+   json-api/index
+   daml2js/index
+   app-dev/bindings-ts/index
    DAML Script <daml-script/index>
    upgrade/index
+   app-dev/authentication
+   app-dev/ledger-api
 
 Deploying to DAML ledgers
 -------------------------
@@ -78,7 +77,6 @@ Background concepts
    concepts/glossary
    concepts/ledger-model/index
 
-
 Examples
 --------
 
@@ -88,22 +86,19 @@ Examples
 
    examples/examples
 
-Experimental features
+Early Access Features
 ---------------------
 
 .. toctree::
    :titlesonly:
    :maxdepth: 2
 
-   experimental/warning
+   tools/navigator/console
+   tools/extractor
    daml-integration-kit/index
-   json-api/index
    triggers/index
    daml-repl/index
    tools/visual
-   daml2js/index
-   getting-started/index
-   getting-started/testing
 
 Support and updates
 -------------------

diff --git a/docs/source/app-dev/bindings-java/index.rst b/docs/source/app-dev/bindings-java/index.rst
@@ -10,7 +10,8 @@ Java bindings
   :hidden:
 
   codegen
-  example
+  Ping Pong Example <example>
+  Iou Quickstart </getting-started/quickstart>
 
 The Java bindings is a client implementation of the *Ledger API*
 based on `RxJava <https://github.com/ReactiveX/RxJava>`_, a library for composing asynchronous and event-based programs using observable sequences for the Java VM. It provides an idiomatic way to write DAML Ledger applications.

diff --git a/docs/source/app-dev/grpc/index.rst b/docs/source/app-dev/grpc/index.rst
@@ -6,12 +6,6 @@
 gRPC
 ####
 
-.. toctree::
-   :hidden:
-
-   proto-docs
-   daml-to-ledger-api
-
 If you want to write an application for the ledger API in other languages, you'll need to use `gRPC <https://grpc.io>`__ directly.
 
 If you're not familiar with gRPC and protobuf, we strongly recommend following the `gRPC quickstart <https://grpc.io/docs/quickstart/>`__ and `gRPC tutorials <https://grpc.io/docs/tutorials/>`__. This documentation is written assuming you already have an understanding of gRPC.

diff --git a/docs/source/app-dev/ledger-api.rst b/docs/source/app-dev/ledger-api.rst
@@ -8,7 +8,15 @@ The Ledger API
    :hidden:
 
    services
+   grpc/index
+   grpc/proto-docs
+   grpc/daml-to-ledger-api
    daml-lf-translation
+   bindings-java/index
+   bindings-scala/index
+   bindings-js
+   bindings-x-lang/index
+
 
 To write an application around a DAML ledger, you'll need to interact with the **Ledger API** from
 another language. Every ledger that DAML can run on exposes this same API.

diff --git a/docs/source/daml-repl/index.rst b/docs/source/daml-repl/index.rst
@@ -4,7 +4,7 @@
 DAML REPL
 ###########
 
-**WARNING:** DAML REPL is an experimental feature that is actively
+**WARNING:** DAML REPL is an early access feature that is actively
 being designed and is *subject to breaking changes*.
 We welcome feedback about the DAML REPL on
 `our issue tracker <https://github.com/digital-asset/daml/issues/new>`_

diff --git a/docs/source/daml-script/index.rst b/docs/source/daml-script/index.rst
@@ -9,7 +9,7 @@ DAML Script
 
    daml-script-docs
 
-DAML scenarios provide a simple API for experimenting with DAML models
+DAML scenarios provide a simple API for testing DAML models
 and getting quick feedback in DAML studio. However, scenarios are run
 in a special process and do not interact with an actual ledger. This
 means that you cannot use scenarios to test other ledger clients,

diff --git a/docs/source/examples/examples.rst b/docs/source/examples/examples.rst
@@ -12,4 +12,4 @@ We have plenty of example code, both of DAML and of applications around DAML, on
 - `Repurchase agreement example <https://github.com/digital-asset/ex-repo-market>`_: DAML code and automation using the Java bindings
 - `Upgrading DAML templates example <https://github.com/digital-asset/ex-upgrade>`_: DAML code
 - `Java bindings tutorial <https://github.com/digital-asset/ex-java-bindings>`_: Three examples using the Java bindings with a very simple DAML model
-- `Node.js tutorial <https://github.com/digital-asset/ex-tutorial-nodejs>`_: Step-by-step running through using the experimental Node.js bindings
+- `Node.js tutorial <https://github.com/digital-asset/ex-tutorial-nodejs>`_: Step-by-step running through using the Node.js bindings
diff --git a/docs/source/experimental/warning.rst b/docs/source/experimental/warning.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -18,7 +18,8 @@ DAML SDK documentation
    :caption: Getting started
 
    Installing the SDK <getting-started/installation>
-   Quickstart Guide <getting-started/quickstart>
+   getting-started/index
+   getting-started/testing
 
 .. toctree::
    :titlesonly:
@@ -41,16 +42,13 @@ DAML SDK documentation
    :caption: Building applications
 
    app-dev/app-arch
-   app-dev/authentication
-   app-dev/ledger-api
+   json-api/index
+   daml2js/index
    app-dev/bindings-ts/index
-   app-dev/bindings-java/index
-   app-dev/bindings-scala/index
-   app-dev/bindings-js
-   app-dev/grpc/index
-   app-dev/bindings-x-lang/index
    DAML Script <daml-script/index>
    upgrade/index
+   app-dev/authentication
+   app-dev/ledger-api
 
 .. toctree::
    :titlesonly:
@@ -95,18 +93,14 @@ DAML SDK documentation
    :titlesonly:
    :maxdepth: 2
    :hidden:
-   :caption: Experimental features
+   :caption: Early Access Features
 
-   experimental/warning
+   tools/navigator/console
+   tools/extractor
    daml-integration-kit/index
-   tools/ledger-api-test-tool/index
-   json-api/index
-   DAML Triggers <triggers/index>
-   DAML Repl <daml-repl/index>
+   triggers/index
+   daml-repl/index
    tools/visual
-   daml2js/index
-   getting-started/index
-   getting-started/testing
 
 .. toctree::
    :titlesonly:

diff --git a/docs/source/triggers/index.rst b/docs/source/triggers/index.rst
@@ -9,7 +9,7 @@ DAML Triggers - Off-Ledger Automation in DAML
 
    trigger-docs
 
-**WARNING:** DAML Triggers are an experimental feature that is actively
+**WARNING:** DAML Triggers are an early access feature that is actively
 being designed and is *subject to breaking changes*.
 We welcome feedback about DAML triggers on
 `our issue tracker <https://github.com/digital-asset/daml/issues/new?milestone=DAML+Triggers>`_

diff --git a/navigator/backend/src/main/scala/com/digitalasset/navigator/config/Arguments.scala b/navigator/backend/src/main/scala/com/digitalasset/navigator/config/Arguments.scala
@@ -161,7 +161,7 @@ object Arguments {
         .children(hostname, port)
 
       cmd("console")
-        .text("start the console")
+        .text("start the console (early access)")
         .action(
           (_, arguments) =>
             arguments.copy(

diff --git a/release/sdk-config.yaml.tmpl b/release/sdk-config.yaml.tmpl
@@ -12,7 +12,7 @@ commands:
   completion: true
 - name: create-daml-app
   path: daml-helper/daml-helper
-  desc: "Create a new DAML project based on create-daml-app (experimental)"
+  desc: "Create a new DAML project based on create-daml-app"
   args: ["create-daml-app"]
   completion: true
 - name: init
@@ -58,11 +58,11 @@ commands:
   args: ["run-jar", "--logback-config=daml-sdk/navigator-logback.xml", "daml-sdk/daml-sdk.jar", "navigator"]
 - name: extractor
   path: daml-helper/daml-helper
-  desc: "Launch the Extractor"
+  desc: "Launch the Extractor (early access)"
   args: ["run-jar", "--logback-config=daml-sdk/extractor-logback.xml", "daml-sdk/daml-sdk.jar", "extractor"]
 - name: ledger
   path: daml-helper/daml-helper
-  desc: "Interact with a DAML ledger (experimental)"
+  desc: "Interact with a DAML ledger"
   args: ["ledger"]
   completion: true
 - name: codegen
@@ -72,20 +72,20 @@ commands:
   completion: true
 - name: deploy
   path: daml-helper/daml-helper
-  desc: "Deploy DAML project to a ledger (experimental)"
+  desc: "Deploy DAML project to a ledger"
   args: ["deploy"]
   completion: true
 - name: ide
   path: damlc/damlc
   args: ["lax", "ide"]
 - name: json-api
   path: daml-helper/daml-helper
-  desc: "Launch the HTTP JSON API (experimental)"
+  desc: "Launch the HTTP JSON API"
   args: ["run-jar", "--logback-config=daml-sdk/json-api-logback.xml", "daml-sdk/daml-sdk.jar", "json-api"]
 - name: trigger
   path: daml-helper/daml-helper
   args: ["run-jar", "--logback-config=daml-sdk/trigger-logback.xml", "daml-sdk/daml-sdk.jar", "trigger"]
-  desc: "Run a DAML trigger (experimental)"
+  desc: "Run a DAML trigger (early access)"
 - name: script
   path: daml-helper/daml-helper
   args: ["run-jar", "--logback-config=daml-sdk/script-logback.xml", "daml-sdk/daml-sdk.jar", "script"]
@@ -97,4 +97,4 @@ commands:
 - name: repl
   path: damlc/damlc
   args: ["repl"]
-  desc: "Launch the DAML REPL (experimental)"
+  desc: "Launch the DAML REPL (early access)"