edd73384c4
Currently sandbox only supports TLS if you also enable client authentication. There is no reason for why this has to be the case and for things like DABL we want TLS without client authentication so it’s useful to be able to test this in sandbox. This PR introduces a `--client-auth` flag that allows you to configure the behavior. The default is the current one of requiring client authentication. This PR does not yet update Java clients, however, the Haskell client supports this already and is used to test this functionality. I’ve also added a section in the documentation on TLS (there were no docs at all so far). changelog_begin - [DAML Sandbox] When Sandbox is run with TLS enabled, you can now configure the requirement for client authentication via ``--client-auth``. See https://docs.daml.com/tools/sandbox.html#running-with-tls for more information. changelog_end |
||
---|---|---|
.. | ||
configs | ||
scripts | ||
source | ||
theme | ||
.gitignore | ||
BUILD.bazel | ||
error.html | ||
README.md | ||
redirect_template.html | ||
redirects.map |
DAML SDK documentation
This directory contains all of the documentation that gets published to docs.daml.com.
Writing documentation
The docs are written in reStructuredText, built using Sphinx.
To edit documentation:
-
Same as code: find the file, edit it on a branch, make a PR.
-
For new files, best to copy existing ones, to get the formatting right.
Don't forget you need to add your file to the
toctree
in/docs/source/index.rst
and/docs/configs/pdf/index.rst
. -
Make sure you preview before you push.
Generated documentation
Not all of our docs are in rst files: some get generated. They are:
- the ledger API proto docs
- the DAML standard library reference
- the Java bindings reference
To edit those docs, edit the content inside the code source.
Previewing
To preview the full docs, as deployed to docs.daml.com, run scripts/preview.sh
.
To live-preview the docs, run scripts/live-preview.sh
. The script accepts two flags:
--pdf
includes the PDF documentation--gen
includes the generated documentation
Note that neither PDF, nor generated docs will benefit from live updates. To update generated docs or PDF docs, quit the preview script with CTRL+C and start it again.
Style conventions
For terminology and other style questions, follow the main DA documentation style guide.
A few pieces of RST guidance:
If you’re not familiar, it’s really worth reading the primer for the basic syntax (emphasis, code text, lists, tables, images, comments, etc).
-
Keep paragraphs all on the same line (no newlines/line breaks).
-
Heading underlines in this hierarchical order:
###### ****** ====== ------ ^^^^^^ """"""
-
For internal links, use the
doc
directive where you can. -
For bullet points (unordered lists), use
-
(dashes). -
For code blocks, use the
literalinclude
directive if you can: it's best to source code from files that we test whether they compile.
How the docs get built
The docs get built as part of the main daml
repo CI, to make sure we don't break any links or do anything else that would cause Sphinx warnings.
Publishing docs
Documentation is published automatically whenever a release is made public on Github. Note that there is a delay so you might have to wait up to an hour until the docs are published after making a release public.
Testing code in docs
TBD