Clarify version dependency between ccf-app and npm-app (#3416)

This commit is contained in:
Eddy Ashton 2022-01-18 14:58:30 +00:00 коммит произвёл GitHub
Родитель 777b623b4c
Коммит 4ea640c66c
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 19 добавлений и 36 удалений

Просмотреть файл

@ -22,7 +22,7 @@ These endpoints can read or mutate the state of a unique :ref:`build_apps/kv/ind
:align: left
:doc:`example`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^
Sample CCF application written in C++.
@ -30,13 +30,20 @@ These endpoints can read or mutate the state of a unique :ref:`build_apps/kv/ind
.. image:: ../img/ts.svg
:width: 22
:alt: C++
:alt: TypeScript
:align: left
:doc:`js_app`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:doc:`js_app_ts`
^^^^^^^^^^^^^^^
Sample CCF application written in TypeScript or JavaScript.
Sample CCF application written in TypeScript, using the API specified in :typedoc:package:`ccf-app`.
---
:fa:`luggage-cart` :doc:`js_app_bundle`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Description of the bundle format for JS applications in CCF.
---
@ -93,7 +100,8 @@ These endpoints can read or mutate the state of a unique :ref:`build_apps/kv/ind
install_bin
example
js_app
js_app_ts
js_app_bundle
build_app
run_app
demo

Просмотреть файл

@ -1,21 +0,0 @@
JavaScript Application
======================
A JavaScript application is a collection of arbitrary JavaScript endpoints that CCF users can call via HTTP requests.
These endpoints can include a variety of JavaScript modules and read and write to CCF's replicated key-value store.
CCF includes a native ``js_generic`` application which can execute JavaScript applications proposed through governance.
The following subpages demonstrate how to build JavaScript applications using modern development tools:
.. toctree::
:maxdepth: 1
js_app_ts
The low-level deployment format for all JavaScript applications in CCF is called `bundle`.
The specification of bundles can be found here:
.. toctree::
:maxdepth: 1
js_app_bundle

Просмотреть файл

@ -13,12 +13,7 @@ This page documents the components of a bundle and the JavaScript API available
`TypeScript <https://www.typescriptlang.org/>`_.
CCF provides an example app built with these tools.
They involve a `build` step that generates an app bundle suitable for CCF.
See the following for more details:
.. toctree::
:maxdepth: 1
js_app_ts
See the :ref:`TypeScript Application <build_apps/js_app_ts>` section for more details
Folder Layout
-------------

Просмотреть файл

@ -3,9 +3,10 @@ TypeScript Application
This guide shows how to build a TypeScript application using Node.js and npm.
The source code for the example app can be found in the
The current source code for the example app can be found in the
`tests/npm-app <https://github.com/microsoft/CCF/tree/main/tests/npm-app>`_
folder of the CCF git repository.
To test against a released version use the same directory within that release, for instance from the `1.0.16 release <https://github.com/microsoft/CCF/tree/ccf-1.0.16/tests/npm-app>`_.
Prerequisites
-------------
@ -57,8 +58,8 @@ Dependencies
The sample uses several runtime and development packages (see ``package.json``).
One of them is the :typedoc:package:`ccf-app` package.
This package is referenced locally using ``file:``.
You should replace this with a reference to a recently published version (adjust the version number accordingly), to match the version of CCF you are running:
This package references the current branch's version of the ``ccf-app`` package using ``file:``.
To test against a published version you should adjust the version number accordingly:
.. code-block:: js