Commit Graph

6 Commits

Author SHA1 Message Date
Darko Pilav
1a84c007e5
Minor Docs fixes (#2277)
* Fix typo in README.md and stale link in CONTRIBUTING.md

* Fix minor typos in quickstart

* Fix various minor typos/mistakes in DAML Intro

* Make DAML code in quickstart-java example cleaner

Also update module hash as well as screenshots in docs
2019-07-25 16:02:42 +02:00
Stefano Baghino
b2d9095a3c
Move unreleased user-facing features to its own file (#1762)
* Move unreleased user-facing features to its own file

docs/source/support/release-notes.rst unfortunately represents a "global
lock" when it comes to submitting contributions: if another contribution
changed it while another was going through the CI/review process, the
latter would have to go again through the CI build after resolving the
conflict and merging the resulting commit.

The contributors originally tried to address this problem by letting the
system automatically performing this operation, but this failed because
release notes were moved to the wrong section by mistake.

This simple change would allow the contributors to let the system take
care of merging on its own, because existing release notes will no
longer be corrupted by the process.

There is a caveat: the automatic merging could result in invalid RST
(mostly because of missing newlines). This would push the task of
ensuring the release notes are valid RST to the release. I would argue
this can be done quite easily and that this is checked automatically
when rendering RST to HTML, so it could be a nuisance during release but
it would make the day-to-day contributions easier.

* Address https://github.com/digital-asset/daml/pull/1762#issuecomment-503540993

* Address https://github.com/digital-asset/daml/pull/1762#pullrequestreview-251676158

* Address https://github.com/digital-asset/daml/pull/1762#discussion_r295279530

* Remove HEAD section from release-notes.rst

* Address https://github.com/digital-asset/daml/pull/1762#pullrequestreview-251678791

* Address https://github.com/digital-asset/daml/pull/1762#issuecomment-503549896
2019-06-19 16:32:03 +02:00
Neil Mitchell
86b16997af
Clean up the guidelines for PR title/description (#427) 2019-04-12 11:33:11 +01:00
Beth Aitman
40ad0026ba
Tidying up the README (#196)
* Tidying up the README

* Tidying contributing page as well

* Apply review suggestion

Co-Authored-By: bethaitman-da <42940582+bethaitman-da@users.noreply.github.com>

* Address more review comments

* Address review comment
2019-04-04 18:04:12 +02:00
Francesco Mazzoli
9c7357c7de update all references of old repo to new repo 2019-04-04 16:20:07 +02:00
Digital Asset GmbH
05e691f558 open-sourcing daml 2019-04-04 09:33:38 +01:00