Commit Graph

1158 Commits

Author SHA1 Message Date
carrielaben-da
3ff5cb6292
TOC index pages (#13468)
Adding text to the previously blank index pages on the Daml side of the documentation (text for the Canton side to follow.)

[CHANGELOG_BEGIN]

[CHANGELOG_END]

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
2022-03-31 11:12:58 -04:00
Gary Verhaegen
3629d1915a
docs: fix canton ref (#13482)
The referenced section is here:
https://github.com/DACH-NY/canton/blob/main/docs-open/src/sphinx/architecture/ha.rst

It already contains a label definition, but it doesn't directly match
the title. I've tested this fix locally by building the combined docs.

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-31 14:29:39 +00:00
davidrichards-da
a010f7cf5b
Enterprise v open source table (#13459)
* Added differences between the enterprise & open source editions

Added differences between the enterprise & open source editions & clearer instructions on how to download Canton.

* Empty commit with changelog notation

CHANGELOG_BEGIN
CHANGELOG_END

* Apply suggestions from code review

Typo's spotted by Carrie.

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

* Updated the enterprise v open source table

Updated the enterprise v open source table with links and making sure all rows are relevant

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
2022-03-31 11:17:22 +01:00
Artúr Poór
3193d54246
docs: highlight json api supports multi-party submissions (#13409)
* docs: highlight json api supports multi-party submissions

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-31 11:41:05 +02:00
davidrichards-da
ef55141788
Added clarity around security risk errors (#13407)
* Adding section to error codes page and updating descriptions

CHANGELOG_BEGIN
CHANGELOG_END
Added a section in the error codes page and improved description to errors

* Removing the multi-line descriptions

* Changing the added sentence

swapping 'due to security reasons' 'for security reasons'

* Updated formatting

Ran the fmt.sh script to give me the correct formatting.

* Updating the generated error codes

CHANGELOG_BEGIN
CHANGELOG_END
Updating the generated error codes
2022-03-30 15:50:00 +01:00
Victor Peter Rouven Müller
cc06073333
Java bindings/interface support (#13366)
* WIP

* First working version of java codegen daml interface support

* Update language-support/java/codegen/BUILD.bazel

Co-authored-by: Remy <remy.haemmerle@daml.com>

* Fix compile errors

* Simplify code massivly, enjoy less duplication

changelog_begin

- The Java codegen now has basic support for daml interface definitions. Converting a contract id of a template implementing an interface to a contract id of the interface is possible and both executing interface choices is possible on the contract id of the interface and implementing template.

changelog_end

* Rename the test file to reflect it is a test file & enhance the inner test name & extend it further

* Fix test

* Refactor parts of TemplateClass.scala into multiple files

* Format that files!

* Minimize duplication further

* Remove unused comment

* Simplify code
Co-authored-by: Stephen Compall <stephen.compall@daml.com>

* Update language-support/java/codegen/src/main/scala/com/digitalasset/daml/lf/codegen/CodeGenRunner.scala

Co-authored-by: Stephen Compall <stephen.compall@daml.com>

* Further refactoring and renaming of the TemplateClassSpec to ContractIdClassBuilderSpec

* Fix formatting

* Add interface docs

* Remove unnecessary code generation of the Contract class for interface types

* Use less bool flags and more good function names :)

* Fix build

Co-authored-by: Remy <remy.haemmerle@daml.com>
Co-authored-by: Stephen Compall <stephen.compall@daml.com>
2022-03-29 12:38:00 +02:00
Gary Verhaegen
a994288f96
damlc visual docs: remove <> (#13398)
These characters have a special meaning in Bash, so it's better to avoid
them as placeholders.

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-24 15:07:39 +00:00
Moisés Ackerman
a88079e41a
Interface reference docs, cont. (#13378)
changelog_begin
changelog_end
2022-03-23 18:33:03 +01:00
Stefano Baghino
d1feab0796
Address review comments on documentation improvements (#13386)
* Address review comments on documentation improvements

Address https://github.com/digital-asset/daml/pull/13381#pullrequestreview-918754656

changelog_begin
changelog_end

* Address https://github.com/digital-asset/daml/pull/13381#discussion_r833249949

* Address https://github.com/digital-asset/daml/pull/13381#discussion_r833253079

* Address https://github.com/digital-asset/daml/pull/13381#discussion_r833254062
2022-03-23 10:57:08 -04:00
Stefano Baghino
30acaaea77
Document how to connect HTTP JSON API Service to an HA participant (#13381)
* Document how to connect HTTP JSON API Service to an HA participant

Fixes https://github.com/digital-asset/daml/issues/13369

changelog_begin
changelog_end

* Add dummy Canton docs ref for `high-availability`
2022-03-23 13:05:15 +01:00
Moisés Ackerman
9f6c1757bc
Interface reference docs (#13337)
* Prefix contract keys and exceptions reference docs with 'Reference:' to match siblings

* Interface reference docs: syntax

* Interface reference docs: functions

changelog_begin
changelog_end
2022-03-23 10:43:39 +01:00
Stephen Compall
d37a63f56e
interface choices in json-api (#13301)
This expands the domain of the exercise endpoint to accept interface IDs
instead of template IDs when exercising by contract ID. The argument is
still [compatibly] called templateId; interface IDs are accepted nowhere
else.

CHANGELOG_BEGIN
- [JSON API] Supports interface choices, including exercise by contract
  ID accompanied by an interface ID.
  See `issue #13301 <https://github.com/digital-asset/daml/pull/13301>`__.
CHANGELOG_END
2022-03-18 17:47:30 +00:00
Stefano Baghino
0b662a77bd
Fix typo in HTTP JSON API Service docs (#13331)
Addresses https://github.com/digital-asset/daml/pull/13330/files#r829985080

changelog_begin
changelog_end
2022-03-18 15:29:46 +01:00
Stefano Baghino
a4abb4ef9e
Remove mentions of the token for package retrieval (#13330)
It has been removed some time ago.

changelog_begin
changelog_end
2022-03-18 12:53:30 +00:00
Stefano Baghino
24d3da70e8
Do not point at a milestone from the HTTP JSON API docs (#13281)
We recently started to use a project board to prioritize our work.

As such, we will soon remove our milestones and move relevant tickets
to the board after ensuring that all items that belong to us are
tracked by the appropriate team label (`team/app-runtime`).

changelog_begin
changelog_end
2022-03-14 16:31:35 +01:00
Stefano Baghino
4b864854a8
Improve description of the HTTP JSON API in the Ledger API docs (#13271)
Improve description of the HTTP JSON API in the Ledger API docs

changelog_begin
changelog_end

Fixes #13029
2022-03-14 14:59:20 +00:00
pbatko-da
e69343dfb3
[Error codes] Reorganize error groups file structure for better readability and easier modification. [DPP-606] (#13263)
changelog_begin
changelog_end
2022-03-14 15:13:26 +01:00
pbatko-da
92e3e9e2df
Add unit tests for ErrorCode [DPP-799] (#13236)
changelog_begin
changelog_end
2022-03-14 12:38:23 +01:00
pbatko-da
a8c0984d9b
[User management] Make use of UM error group in the docs (#13260)
changelog_begin
changelog_end
2022-03-14 12:09:48 +01:00
pbatko-da
df2cb4a1fd
[Error codes doc] Put generated source files of error inventories under version control [DPP-606][DPP-777] (#13181)
And add a check (a unit test) that the generated files are up-to-date with what can be generated.
If the check fails then one will need to run `./docs/scripts/gen-error-docs-src.sh` and commit the changes.

changelog_begin
changelog_end
2022-03-10 12:06:58 +01:00
Remy
851fb53083
add milli/micro-seconds to RelTime and fix doc (#13217)
CHANGELOG_BEGIN
CHANGELOG_END
2022-03-09 19:09:10 +00:00
Simon Maxen
cad7928220
Metering cleanup [DPP-937] (#13210)
* Make no-op metering logging debug

* Address statistic defaulting TODOs

* TODO replaced with ticket

* Switch to using assertLedgerMeteringEnd when ledgering end must be populated

* Note in docs that ledger metering is not affected by participant pruning

* Address review comments leftover from DPP-819

* Switch to using cSQL for options and offsets

changelog_begin
changelog_end
2022-03-09 19:06:04 +00:00
Gary Verhaegen
7f35d3dc27
update daml.com URLs (#13226)
Requested by Olivia Yu.

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-09 18:15:40 +00:00
Simon Maxen
1d40c55177
Add metering report http endpoint [DPP-855] (#13147)
* Added metering report http endpoint

changelog_begin
Added metering report http endpoint
changelog_end

* Update with review comments
2022-03-09 14:59:08 +00:00
Moritz Kiefer
212bc9fdf3
Drop more controller can from the docs (#13215)
* Drop more controller can from the docs

changelog_begin
changelog_end

* .

changelog_begin
changelog_end
2022-03-09 11:35:54 +01:00
Moritz Kiefer
4e004e0a88
Replace scenario messages with script (#13207)
* Replace scenario messages with script

In theory we could try to be clever and print the "right" thing. In
practice, scenarios are almost dead so the complexity for that doesn’t
seem worth it.

fixes #13178

changelog_begin
changelog_end

* .
2022-03-09 11:35:37 +01:00
Gary Verhaegen
dfa648f585
hunt down DAML better (#13195)
Process:

- `git ls-files -z | xargs -0 -n 100 sed -i --follow-symlinks 's/DAML/Daml/g'`
- `git add -p`
- `git restore -p`
- Check there is no unstaged change left.

To review:

- Check for false positives by carefully reviewing the diff in this PR.
- Check for false negatives with `git grep DAML`.
- Quicker check for fals positives:

```
git grep DAML | grep -v migration | grep -v DAML_
```

Fixes #13190

Note: This is the "second half" of #13191, which failed to cover all the
remaining DAMLs because of:

```
$ git ls-files | grep "'"
compiler/damlc/tests/daml-test-files/MangledScenario'.daml
```

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-08 17:04:58 +01:00
pbatko-da
96029b7cf3
[Docs] Expand User Management service section (and remove a duplicate section) [DPP-943] (#13108) 2022-03-02 18:59:40 +01:00
Bernhard Elsner
140360fa0c
Fix a few docs redirects (#13126)
CHANGELOG_BEGIN
CHANGELOG_END
2022-03-02 15:16:56 +01:00
Stefano Baghino
f5c4755b76
Improve docs of auth middleware and trigger service (#13111)
* Improve docs of auth middleware and trigger service

changelog_begin
changelog_end

Fix #13049
Fix #13048

Several improvements to the documentation for these two services. The main aim was
to add, where needed, references to the new user management service. Ultimately,
only the auth middleware really needed to add a note about it, since to the trigger
service this is (so far) completely transparent.

For the rest, I took advantage of the chance to polish the docs a bit and make a few
improvements (that I will describe more in depth in a self-review).

* Prevent copy-pasting drama.

Thanks @S11001001

Co-authored-by: Stephen Compall <stephen.compall@daml.com>

* Address https://github.com/digital-asset/daml/pull/13111#discussion_r816967559

* Address https://github.com/digital-asset/daml/pull/13111#discussion_r816970609

* Address https://github.com/digital-asset/daml/pull/13111#discussion_r816973727

Co-authored-by: Stephen Compall <stephen.compall@daml.com>
2022-03-02 11:51:58 +00:00
Moritz Kiefer
6bb74786b9
Document docs HEAD build (#13121)
I used that script a few times myself and had a few people ask for it
so lets document it.

changelog_begin
changelog_end
2022-03-02 10:32:00 +01:00
Stefano Baghino
ef8a0e662d
Describe the behavior of different token formats in the HTTP JSON API (#13082)
Fixes #12440

changelog_begin
changelog_end
2022-02-28 17:15:21 +00:00
davidrichards-da
23dd7c3303
Removed two links (#13092)
CHANGELOG_BEGIN
CHANGELOG_END

Removed two links from identity and package management and overview.
2022-02-25 16:05:10 +00:00
davidrichards-da
585f695eb8
Adding an installing daml enterprise link (#13088)
CHANGELOG_BEGIN
CHANGELOG_END

Adding an installing daml enterprise link to help with the Canton Docs
2022-02-25 15:20:07 +00:00
Moritz Kiefer
c09e1d4b96
Document user management support in Navigator (#13085)
* Document user management support in Navigator

fixes #12934

changelog_begin
changelog_end
2022-02-25 16:11:51 +01:00
davidrichards-da
5dd6accb08
Adding a link to Daml Intro (#13074)
* Adding a link to Daml Intro

Adding a link to Daml Intro for Canton to link to.  Canton changes being made to link to this in the same docs, rather than the external links.

* Blank commit

CHANGELOG_BEGIN
CHANGELOG_END
2022-02-25 13:05:20 +00:00
Moritz Kiefer
5dfc2e4a98
Fix GSG to account for login requirement (#13073)
* Fix GSG to account for login requirement

You can only follow a user after they logged in so the previous order
did no longer work.

changelog_begin
changelog_end

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

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

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

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

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

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

* fix borked sentence

changelog_begin
changelog_end

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

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

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

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>

Co-authored-by: carrielaben-da <91496516+carrielaben-da@users.noreply.github.com>
2022-02-25 13:07:56 +01:00
Simon Maxen
728f03c855
Participant metering documentation (#13070)
* Participant metering documentation

changelog_begin
Participant metering added to Daml operating insturctions documentation
changelog_end
2022-02-25 10:59:20 +00:00
Moritz Kiefer
9dee577138
Document ToC doc updates (#13069)
changelog_begin
changelog_end
2022-02-25 08:53:01 +01:00
carrielaben-da
55590d916b
Update app-architecture.rst (#12993)
* Update app-architecture.rst

Second-iteration changes to the App Architecture page, addressing User Management and the Alias contract.

[CHANGELOG_BEGIN]
[CHANGELOG_END]

* Update app-architecture - edits - 1

Which/ how many additional details about the public party do you want to include here? Or as another option, should it be explained in-depth elsewhere?

[CHANGELOG_BEGIN]
[CHANGELOG_END]

* Update docs/source/getting-started/app-architecture.rst

Adding Moritz's suggested changes

[CHANGELOG_BEGIN]
[CHANGELOG_END]

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

* Update docs/source/getting-started/app-architecture.rst

Changed to Moritz's suggested wording.

[CHANGELOG_BEGIN]
[CHANGELOG_END]

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

* Update docs/source/getting-started/app-architecture.rst

Adding Moritz's suggestion w/link.

[CHANGELOG_BEGIN]
[CHANGELOG_END]

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

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
2022-02-24 10:18:40 -05:00
davidrichards-da
0ed1e0526b
Moving the 'testing your web app' page to the GSG (#13060)
* Moving the 'testing your web app' page to the GSG

CHANGELOG_BEGIN
CHANGELOG_END

Moving the 'testing your web app' page to the GSG

* Updating paths after moving the file

Updating paths after moving the file

* Adding the testing page to the pdf file too.

* Adding a link to the user management description

CHANGELOG_BEGIN
CHANGELOG_END

Adding a link to the user management description

* fixing link in first-feature linking to the moved page

fixing link in first-feature linking to the moved page

* Updating a link to the testing file

Updating a link to the testing file
2022-02-24 13:00:48 +00:00
davidrichards-da
0583b1879f
Updating the GSG architecture diagram (#13067)
CHANGELOG_BEGIN
CHANGELOG_END

Updating the GSG architecture diagram
2022-02-24 12:02:24 +00:00
Moritz Kiefer
bd1ae4cae7
Enable html4 writer in sphinx (#13056)
The sphinx update switched to an html 5 writer by default which broke
a bunch of our CSS which I unfortunately missed. While that is
definitely fixable, a few days before our 2.0 release this doesn’t
seem sensible to focus on so for now let’s force the html4 writer.

changelog_begin
changelog_end
2022-02-24 12:27:02 +01:00
Stefano Baghino
21769eaff5
Move Daml Helm Chart and Auth0 setup pages to early access (#13052)
Add a disclaimer that these pages do not work with Daml 2.0
but are under active development.

Closes #13038
Closes #13039

changelog_begin
changelog_end
2022-02-24 10:51:08 +00:00
Jennifer Whyte
2f86d8d37c
Update ledger overview list (#13030)
* Update ledger overview list

CHANGELOG_BEGIN
CHANGELOG_END

* Update deploying.rst

CHANGELOG_BEGIN
CHANGELOG_END

* Update deploying.rst

fixing typo

CHANGELOG_BEGIN
CHANGELOG_END

* Update app-arch.rst

Remove link to deleted page

* Update packages.rst

Remove more links to deploy page

CHANGELOG_BEGIN
CHANGELOG_END

* Update authorization.rst

changelog_begin
changelog_end

* Update packages.rst

Adding links back

CHANGELOG_BEGIN
CHANGELOG_END

* Update packages.rst

link fix

CHANGELOG_BEGIN
CHANGELOG_END

* Update docs/source/daml/reference/packages.rst

changelog_begin
changelog_end

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

Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
2022-02-23 16:03:23 -05:00
davidrichards-da
e33c8aa8a0
Replacing the Application Architecture Image (#13054)
* Replacing the Application Architecture Image

CHANGELOG_BEGIN
CHANGELOG_END

Replacing the Application Architecture Image for an updated version and making a few small changes in to the copy.

* Update docs/source/app-dev/app-arch.rst

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

* Adding the path from the daml model to the DAR

Adding the missing path from the daml model to the DAR to the architecture image

* Update docs/source/app-dev/app-arch.rst

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

Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
2022-02-23 19:48:31 +00:00
carrielaben-da
e4ba32dfe1
Releases and Versioning typo fix (#13058)
To address a typo in line 27

[CHANGELOG_BEGIN]
[CHANGELOG_END]

Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
2022-02-23 14:12:32 -05:00
davidrichards-da
0153a4084f
Removing the 'ledger topologies' page (#13025)
* Removing the 'ledger topologies' page

Removing the 'ledger topologies' page as much of the content is wrong and Canton's 'Architecture in depth' section goes into this in much more detail.  Also removing links to this page.

* Removing links to the removed page

Removing links to the removed topology page

* Removing another link to the page being removed

* Removing another link no longer needed

* Removing another link to the deleted file.

CHANGELOG_BEGIN
CHANGELOG_END

Removing another link

* Remove references to topologies

CHANGELOG_BEGIN
CHANGELOG_END

* Correcting a spelling mistake

Correcting a spelling mistake

* Updating Daml for VMware Blockchain

Updating Daml for VMware Blockchain

Co-authored-by: bame-da <bernhard.elsner@digitalasset.com>
2022-02-23 16:07:26 +00:00
Simon Meier
7d0fadc3ca
user management: document limits (#13040)
* user management: document limits

CHANGELOG_BEGIN
CHANGELOG_END

Co-authored-by: Pawel Batko <pawel.batko@digitalasset.com>
2022-02-23 14:55:05 +01:00
Bernhard Elsner
0b38882505
Update the component statuses page (#13021)
* Update the component statuses page

CHANGELOG_BEGIN
CHANGELOG_END

* Update docs/source/support/component-statuses.rst
2022-02-23 12:41:07 +00:00