Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Full documentation for the new assistant #740

Merged
merged 20 commits into from May 13, 2019

Conversation

Projects
None yet
5 participants
@bethaitman
Copy link
Contributor

commented Apr 26, 2019

As a follow-up PR to #768, this PR moves all of the documentation to use the new daml assistant, including the quickstart guide. We should only merge this when we're happy to encourage users to make the switch from da to daml.

Show resolved Hide resolved docs/source/tools/extractor.rst Outdated
Show resolved Hide resolved docs/source/tools/extractor.rst Outdated
Show resolved Hide resolved docs/source/tools/extractor.rst Outdated
Show resolved Hide resolved docs/source/tools/navigator/console.rst Outdated
Show resolved Hide resolved docs/source/tools/extractor.rst Outdated
Show resolved Hide resolved docs/source/tools/navigator/console.rst Outdated

2. The Navigator web-app is automatically started in your browser. If it fails to start,
open a browser window and point it to the Navigator URL

When running ``da start`` you will see the Navigator URL. By default it will be `<http://localhost:7500/>`_. However, if port ``7500`` is taken, a different port will be picked.
When running ``daml start`` you will see the Navigator URL. By default it will be `<http://localhost:7500/>`_. However, if port ``7500`` is taken, a different port will be picked.

This comment has been minimized.

Copy link
@cocreature

cocreature Apr 26, 2019

Contributor

We don’t pick a new port automatically in the new assistant atm.

This comment has been minimized.

Copy link
@bethaitman

bethaitman Apr 29, 2019

Author Contributor

What is the new behaviour - it'll fail if the port is taken?

This comment has been minimized.

Copy link
@cocreature

cocreature Apr 29, 2019

Contributor

Yeah, we should probably make sure that we at least get a reasonable error message in that case.

This comment has been minimized.

Copy link
@associahedron

associahedron Apr 29, 2019

Contributor

Created the issue #764 to track this.

Show resolved Hide resolved docs/source/tools/navigator/index.rst Outdated
Show resolved Hide resolved docs/source/tools/sandbox.rst Outdated
Show resolved Hide resolved docs/source/tools/sandbox.rst Outdated
@cocreature

This comment has been minimized.

Copy link
Contributor

commented Apr 26, 2019

#720 has the changes required in the quickstart guide. Feel free to copy them into this PR, I don’t think it makes sense to split it over two PRs.

What are you plans for rolling this out? Given that we are planning a migration period where both are supported, removing the old docs seems somewhat unfortunate but I guess it might also nudge people towards switching to the new assistant so it’s not necessarily that bad.

@bethaitman bethaitman referenced this pull request Apr 29, 2019

Closed

Migrate quickstart guide to DAML assistant #720

0 of 5 tasks complete
Show resolved Hide resolved docs/source/tools/assistant.rst Outdated
Show resolved Hide resolved docs/source/tools/assistant.rst Outdated
Show resolved Hide resolved docs/source/tools/assistant.rst Outdated
Show resolved Hide resolved docs/source/tools/assistant.rst Outdated
Show resolved Hide resolved docs/source/tools/assistant.rst Outdated
Show resolved Hide resolved docs/source/tools/extractor.rst Outdated
@associahedron

This comment has been minimized.

Copy link
Contributor

commented Apr 30, 2019

#720 has the changes required in the quickstart guide. Feel free to copy them into this PR, I don’t think it makes sense to split it over two PRs.

I just combined the changes in that PR with this one, updating a couple of lines. Thanks!

What are you plans for rolling this out? Given that we are planning a migration period where both are supported, removing the old docs seems somewhat unfortunate but I guess it might also nudge people towards switching to the new assistant so it’s not necessarily that bad.

As we discussed in the channel, we'll have a quiet internal release where we'll hold back the new docs, and release the new docs once we're confident we've ironed out the most glaring issues that will inevitably come up, probably around the same time as we release the assistant publicly. :-)

@bethaitman bethaitman force-pushed the daml-assistant-doc branch from a85fccc to 155dec7 May 6, 2019

@bethaitman bethaitman changed the title First draft of new assistant docs Full documentation for the new assistant May 6, 2019

@bethaitman bethaitman force-pushed the daml-assistant-doc branch from 4dcd7da to fe06513 May 8, 2019

@bethaitman

This comment has been minimized.

Copy link
Contributor Author

commented May 8, 2019

I think I've done all necessary tidying up, and this is ready to for any final reviews.

@associahedron
Copy link
Contributor

left a comment

👍 Awesome work!

Show resolved Hide resolved docs/source/getting-started/installation.rst Outdated
Show resolved Hide resolved docs/source/getting-started/installation.rst Outdated

sh ./da-cli-<version>.run
curl -sSL https://get.daml.com/ | sh

This comment has been minimized.

Copy link
@associahedron

associahedron May 8, 2019

Contributor

We should add something along the lines of:

Make sure to add ~/.daml/bin to your path if prompted.

after the curl ... | sh step.

Show resolved Hide resolved docs/source/getting-started/quickstart.rst Outdated
@@ -268,7 +263,7 @@ Develop with DAML Studio

Take a look at the DAML that specifies the contract model in the quickstart application. The core template is ``Iou``.

#. Open :doc:`DAML Studio </daml/daml-studio>`, a DAML IDE based on VS Code, by running ``da studio`` from the root of your project.
#. Open :doc:`DAML Studio </daml/daml-studio>`, a DAML IDE based on VS Code, by running ``daml studio`` from the root of your project.

This comment has been minimized.

Copy link
@associahedron

associahedron May 8, 2019

Contributor

I don't know whether/how to improve this, but it's not accurate to say that daml studio needs to be run from the root of the project, it only needs to be run inside the project (not necessarily the root), and that will cause VSCode to be opened at the root of the project.

Suggested change
#. Open :doc:`DAML Studio </daml/daml-studio>`, a DAML IDE based on VS Code, by running ``daml studio`` from the root of your project.
#. Open :doc:`DAML Studio </daml/daml-studio>`, a DAML IDE based on VS Code, by running ``daml studio`` from the root of your project.

This comment has been minimized.

Copy link
@bethaitman

bethaitman May 10, 2019

Author Contributor

I think this is fine within this set of instructions. Will make sure it's clearer elsewhere if it needs to be.

@bethaitman bethaitman force-pushed the daml-assistant-doc branch 2 times, most recently from 3799ed6 to 5799f29 May 10, 2019

@cocreature cocreature force-pushed the daml-assistant-doc branch 5 times, most recently from 2d1b449 to 60e5202 May 13, 2019

bethaitman and others added some commits Apr 26, 2019

@bethaitman bethaitman force-pushed the daml-assistant-doc branch from 60e5202 to 99c9517 May 13, 2019

@mergify mergify bot merged commit 8c8bd5e into master May 13, 2019

7 checks passed

Summary 1 rule matches and 1 potential rule
Details
digital-asset.daml Build #20190513.93 succeeded
Details
digital-asset.daml (Linux) Linux succeeded
Details
digital-asset.daml (Windows) Windows succeeded
Details
digital-asset.daml (macOS) macOS succeeded
Details
digital-asset.daml (perf) perf succeeded
Details
license/cla Contributor License Agreement is signed.
Details

@mergify mergify bot deleted the daml-assistant-doc branch May 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.