Partly because the current version is from February (of this year,
fortunately), and partly because I need a more recent one to bump node
to 18 and fix the GSG for that.
This removes the index.rst files from the repo, and instead generates a
placeholder index that just includes all the rst files at build time.
The reason for this change is that the ToC is defined in docs.daml.com,
and having one on both sides is both confusing and error-prone.
CHANGELOG_BEGIN
CHANGELOG_END
* Removing the Daml Ledgers table
Removes the existing Deploying to Daml Ledgers table and moves Deploying To A Generic Daml Ledger up in the TOC
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Update index.pdf
Conforming the pdf to the rst
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Update packages.rst
Removed reference to a deleted page.
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Update authorization.rst
Removed link to deleted page
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Update authorization.rst
Corrected
[CHANGELOG_BEGIN]
[CHANGELOG_END]
* Update authorization.rst
Additional changes to try to pass the required checks.
[CHANGELOG_BEGIN]
[CHANGELOG_END]
Co-authored-by: carrie-laben <91496516+carrie-laben@users.noreply.github.com>
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
* 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
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
* Upgrade sphinx
Don’t want to be stuck on 1.8.3 forever. The current version is
4.4.0 (this upgrades to 4.3.1 which is the latest in nixpkgs).
I did had to drop footnotebackref. This runs into the same issue as
https://tex.stackexchange.com/questions/137594/hyperref-footnotebackref-in-longtable
but just copying the fix doesn’t work and I don’t understand enough
about the details here to fix this myself.
We have 7 footnotes in the Daml docs + some in the Canton docs. That
does not seem worth sticking on a sphinx version from 2018 for just to
get backreferences from footnotes to the link on the same page.
changelog_begin
changelog_end
* turns out you need fonts maybe
* .
changelog_begin
changelog_end
* suppport :force: in daml-docs
changelog_begin
changelog_end
Somewhat error-prone, so please review carefully.
Reasons we need this:
- Some file types are not properly handled by the script.
- The only exclusion mechanism we currently have (`NO_AUTO_COPYRIGHT`)
is overly coarse.
CHANGELOG_BEGIN
CHANGELOG_END
New year, new copyright, new expected unknown issues with various files
that won't be covered by the script and/or will be but shouldn't change.
I'll do the details on Jan 1, but would appreciate this being
preapproved so I can actually get it merged by then.
CHANGELOG_BEGIN
CHANGELOG_END
* Remove Extractor
Extractor is being removed after a long time being in Labs status.
This should improve the flakiness on CI.
🔥
changelog_begin
Extractor has been removed from the SDK
changelog_end
* Remove Extractor documentation
* Remove Extractor from CODEOWNERS
* Remove Extractor references in Daml-LF build files
* Remove Extractor references in the Daml SDK assistant
* Remove Extractor from the SDK
* Remove Extractor reference from CONTRIBUTING.md
* Refactor docs build
This is in preparation for the split docs build where we publish our
sphinx sources here and then build the final docs combined with the
Canton docs in the assembly repo.
Apologies for the messy diff. The idea here is the following:
1. We bundle together all files used as sphinx inputs in
sphinx-source-tree. This will be what we publish.
2. We factor out the calls to sphinx-build for the pdf and html
build to be as generic as possible and share the code.
3. The existing rules for the html build & pdf docs don’t invoke
sphinx anymore and instead only keep the postprocessing (copying other
html files or calling lualatex).
In a followup PR I’ll also simplify the postprocessing steps and then
finally publish those artifacts as part of our build.
changelog_begin
changelog_end
* fmt
changelog_begin
changelog_end
* .
changelog_begin
changelog_end
* .
changelog_begin
changelog_end
* .
changelog_begin
changelog_end
Adding `Daml Documentation >> Building applications >> "Self-Service Error Codes (Experimental)` section in the HTML documentation.
The section is populated automatically with error code information retrieved from the classpath.
The process of generating documentation for error codes looks like this:
- first we find error codes information from the classpath,
- then we save it to a json file,
- then the json file is made available to a custom Sphinx extension,
- then the custom Sphinx extension generates documentation wherever we put a new custom Sphinx directive.
Try it out with
`./docs/scripts/live-preview.sh`
or
`./docs/scripts/preview.sh`
CHANGELOG_BEGIN
CHANGELOG_END
* Add documentation for the Daml Profiler
changelog_begin
- [Daml Profiler] Daml Connect EE now includes a profiler which can be
used to profile Daml execution time.
changelog_end
* Update docs/source/tools/profiler.rst
Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>
* Make sphinx happy
changelog_begin
changelog_end
Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>
* Support fetching SDK EE tarball in the assistant
This PR adds an `artifactory-api-key` field to `daml-config.yaml`. If
this is set, we will download the SDK EE tarball if it exists, falling
back to GH releases on 404s (for old releases).
changelog_begin
- [Daml Assistant] The assistant now supports an `artifactory-api-key`
field in `daml-config.yaml`. If you have a license for Daml Connect
EE you can specify this and the assistant will automatically fetch
the EE edition which provides additional functionality.
changelog_end
* Hardcode first EE snapshot
changelog_begin
changelog_end
* Replace many occurrences of DAML with Daml
* Update docs logo
* A few more CLI occurrences
CHANGELOG_BEGIN
- Change DAML capitalization and docs logo
CHANGELOG_END
* Fix some over-eager replacements
* A few mor occurrences in md files
* Address comments in *.proto files
* Change case in comments and strings in .ts files
* Revert changes to frozen proto files
* Also revert LF 1.11
* Update get-daml.sh
* Update windows installer
* Include .py files
* Include comments in .daml files
* More instances in the assistant CLI
* some more help texts
* Remove Navigator console
This was a labs feature so we can remove it without a deprecation
cycle. It doesn’t have any known users and is almost completely
superseded by DAML REPL.
@bame-da agreed to the removal.
This also has the nice side effect of eliminating 1 of our 2
dependencies that were not Scala 2.13 compatible.
changelog_begin
- [Navigator Console] The labs feature Navigator Console has been
removed. Users are encouraged to use DAML REPL instead.
changelog_end
* Kill Navigator database docs completely
changelog_begin
changelog_end
* Document participant pruning for operators
CHANGELOG_BEGIN
CHANGELOG_END
* Add references
* Add references and authorization info
* Address review comments
* Keep paragraphs on the same line
* Fix link to Pruning Service
* Add services section for Pruning Service
* Add Pruning Service to service diagrams
* Fix leftover
* How to determine a suitable pruning offset
* Expand determining a suitable offset
* Expand API impacts
* Expand limitations
* Address review comments
* Address review comments
* Remove the examples page from the docs in favour of one on daml.com
CHANGELOG_BEGIN
CHANGELOG_END
* Fix link from /samples to /examples
* Fix link in daml intro
* Fix link, second try
* Replace occurrances of DAML SDK in the docs with appropriate new terms
CHANGELOG_BEGIN
CHANGELOG_END
* Apply suggestions from code review
Revert two renamings.
* Fix broken internal link
- Put Windows first, and add a direct link to the installer.
- Move the manual step to a separate page.
- Link to AdoptOpenJDK as they have by far the simplest download page.
CHANGELOG_BEGIN
CHANGELOG_END
* Update DAML Studio documentation
This updates the DAML Studio docs primarily focusing on the table view
which was completely omitted so far. This also includes the new
disclosure information.
This is probably best reviewed locally.
changelog_begin
changelog_end
* No copyright header for samples
changelog_begin
changelog_end
* Move to SDK tools section
changelog_begin
changelog_end
* fix typo
fixes#6775
changelog_begin
changelog_end
* Update docs/source/daml/daml-studio.rst
Co-authored-by: Sofia Faro <sofia.faro@digitalasset.com>
Co-authored-by: Sofia Faro <sofia.faro@digitalasset.com>
