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

Relabel "Experimental" to "Early Access" and reorganise pages #5411

Merged
merged 1 commit into from
Apr 3, 2020

Conversation

bame-da
Copy link
Contributor

@bame-da bame-da commented Apr 3, 2020

This resolves #5407 and #5408. It's likely to lead to conflicts with some other changes by @S11001001 and @rohanjr, but I thought I'd present my complete suggestion for the tidyup.

CHANGELOG_BEGIN

  • Move daml2ts, bindings-ts and JSON API out of experimental section in docs
  • Rename Experimental to Early Access in docs and assistant
  • Reorganise the docs a little bit to de-emphasise the Ledger API

CHANGELOG_END

Pull Request Checklist

  • Read and understand the contribution guidelines
  • Include appropriate tests
  • Set a descriptive title and thorough description
  • Add a reference to the issue this PR will solve, if appropriate
  • Include changelog additions in one or more commit message bodies between the CHANGELOG_BEGIN and CHANGELOG_END tags
  • Normal production system change, include purpose of change in description

NOTE: CI is not automatically run on non-members pull-requests for security
reasons. The reviewer will have to comment with /AzurePipelines run to
trigger the build.

app-dev/bindings-ts/index
app-dev/bindings-java/index
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is happening to those? You seem to have removed them from the index but it looks like you didn’t believe the files.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I missed that we have a separate index for the ledger API, thanks for the explanation!

@bame-da
Copy link
Contributor Author

bame-da commented Apr 3, 2020 via email

Copy link
Contributor

@cocreature cocreature left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

CHANGELOG_BEGIN

- Move daml2ts, bindings-ts and JSON API out of experimental section in docs
- Rename Experimental to Early Access in docs and assistant
- Reorganise the docs a little bit to de-emphasise the Ledger API

CHANGELOG_END
@bame-da bame-da force-pushed the experimental-feature-tidyup branch from 3beaf33 to 444a810 Compare April 3, 2020 13:17
Copy link
Contributor

@hurryabit hurryabit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome. Thanks a lot!

@rohanjr
Copy link
Contributor

rohanjr commented Apr 3, 2020

Thanks @bame-da! How do you want to coordinate this with #5392? I assume we want both changes right?

@bame-da bame-da merged commit c496e2b into master Apr 3, 2020
@bame-da bame-da deleted the experimental-feature-tidyup branch April 3, 2020 14:29
@bame-da
Copy link
Contributor Author

bame-da commented Apr 3, 2020

You can move the files around if you want to. Moving files and reshuffling the index are completely orthogonal. Since I took your suggestion of moving the quickstart under the java bindings, I don't think there's a real conflict here, probably a merge conflict, though.

S11001001 added a commit that referenced this pull request Apr 3, 2020
S11001001 added a commit that referenced this pull request Apr 3, 2020
* move JSON API doc to "Building applications"

* stop describing JSON API as experimental; limit to calling WebSocket endpoints alpha

* remove "(experimental)" from daml json-api docstring

* add changelog

CHANGELOG_BEGIN
- [JSON API] First stable version of the ``/v1`` endpoints, with
  the exception of the WebSocket endpoints, which remain in alpha.
  See `issue #4458 <https://github.com/digital-asset/daml/issues/4458>`_.
CHANGELOG_END

* move json-api in PDF ToC, adapting to #5411 c496e2b

- pointed out by @cocreature; thanks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename "experimental" to "early access" in docs and assistant
4 participants