Skip to content
This repository was archived by the owner on May 23, 2022. It is now read-only.

Commit 8e578d8

Browse files
authored
Modify the navigation, remove older release notes, split into separate files for 0.6.21 and 0.6.20 (#297)
* Move examples section * TEST * Split up release notes and revise text * Add link to Releases page * Add DRAFT for 0.6.21 * Add envar to modified nav * Not supported locally or remotely yet
1 parent 1515c37 commit 8e578d8

4 files changed

Lines changed: 152 additions & 550 deletions

File tree

modules/ROOT/nav.adoc

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,6 @@
4747
** xref:developers-guide:lang-service-ide.adoc[Language server protocol client]
4848
** xref:developers-guide:glossary.adoc[Glossary]
4949
50-
.xref:developers-guide:sample-apps.adoc[Examples]
51-
** link:https://github.com/dfinity/examples[Examples repository]
52-
** link:https://github.com/dfinity/awesome-dfinity[Awesome DFINITY]
53-
** link:https://github.com/dfinity/linkedup[LinkedUp]
54-
//** link:https://github.com/dfinity/cancan[CanCan]
55-
5650
.xref:languages:languages-overview.adoc[Languages]
5751
* xref:candid-guide:candid-intro.adoc[Candid]
5852
** xref:candid-guide:candid-concepts.adoc[What is Candid?]
@@ -89,16 +83,27 @@
8983
** xref:rust-guide:rust-counter.adoc[Simple counter tutorial]
9084
** xref:rust-guide:multiply-dependency.adoc[Basic dependency tutorial]
9185
** xref:rust-guide:rust-profile.adoc[Profile tutorial]
92-
//** xref:rust-guide:rust-asset-storage.adoc[Asset storage tutorial]
93-
//** xref:rust-guide:rust-chess-autonomous.adoc[Autonomous game tutorial]
86+
////
87+
** xref:rust-guide:rust-asset-storage.adoc[Asset storage tutorial]
88+
** xref:rust-guide:rust-chess-autonomous.adoc[Autonomous game tutorial]
9489
95-
//.Integration
96-
//** xref:integration:ledger-quick-start.adoc[Integrating with the Ledger]
90+
.Integration
91+
** xref:integration:ledger-quick-start.adoc[Integrating with the Ledger]
9792

98-
//.xref:operators-guide:ops-guide.adoc[Operators]
99-
//** xref:operators-guide:ops-guide.adoc[Concepts]
100-
//** xref:operators-guide:ops-how-to.adoc[How to]
101-
//** xref:operators-guide:ops-tutorials.adoc[Tutorials]
102-
//** xref:operators-guide:ops-ref.adoc[Reference]
93+
.xref:operators-guide:ops-guide.adoc[Operators]
94+
** xref:operators-guide:ops-guide.adoc[Concepts]
95+
** xref:operators-guide:ops-how-to.adoc[How to]
96+
** xref:operators-guide:ops-tutorials.adoc[Tutorials]
97+
** xref:operators-guide:ops-ref.adoc[Reference]
98+
////
99+
100+
.xref:developers-guide:sample-apps.adoc[Examples]
101+
** link:https://github.com/dfinity/examples[Examples repository]
102+
** link:https://github.com/dfinity/awesome-dfinity[Awesome DFINITY]
103+
** link:https://github.com/dfinity/linkedup[LinkedUp]
104+
//** link:https://github.com/dfinity/cancan[CanCan]//
103105

104-
.xref:release-notes:sdk-release-notes.adoc[Release notes]
106+
.xref:release-notes:sdk-release-notes.adoc[Release notes]
107+
** xref:release-notes:0.6.21-rn.adoc[0.6.21]
108+
** xref:release-notes:0.6.20-rn.adoc[0.6.20]
109+
** link:https://github.com/dfinity/sdk/releases[Release history]
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
= Highlights of what's new in {release}
2+
:description: DFINITY Canister Software Development Kit Release Notes
3+
:proglang: Motoko
4+
:platform: Internet Computer platform
5+
:IC: Internet Computer
6+
:company-id: DFINITY
7+
:sdk-short-name: DFINITY Canister SDK
8+
:sdk-long-name: DFINITY Canister Software Development Kit (SDK)
9+
:release: 0.6.20
10+
ifdef::env-github,env-browser[:outfilesuffix:.adoc]
11+
12+
The {release} release has both user-facing and internal enhancements, including fixes and updates to {proglang}, the {proglang} base library, and Candid.
13+
14+
== New features and capabilities
15+
16+
The most significant new features and capabilities include updates in the following functional areas:
17+
18+
* <<DFX,DFX>>
19+
* <<Candid,Candid>>
20+
* <<Motoko,Motoko>>
21+
22+
=== DFX
23+
24+
* A new notification message that the DFINITY Canister SDK sends anonymous usage data to DFINITY Stiftung by
25+
default has been added to `+dfx+` commands.
26+
The notification message is only displayed once, the first time you run any `+dfx+` subcommand.
27+
For example, the first time you run `+dfx new+` to create a new project, the notification is displayed before any other project creation messages.
28+
+
29+
The purpose of this notification is to inform you that `+dfx+` is configured to collect anonymous information about `+dfx+` command activity and errors.
30+
Collecting anonymous data is enabled by default in an effort to improve the developer experience based on usage patterns and behavior.
31+
+
32+
If you want to prevent the collection of data about `+dfx+` usage, you can explicitly opt-out by setting the following environment
33+
variable:
34+
+
35+
....
36+
DFX_TELEMETRY_DISABLED=1
37+
....
38+
+
39+
To find out more about the data collected and what your consent means, see the DFINITY Canister SDK link:https://sdk.dfinity.org/sdk-license-agreement.txt[Terms and Conditions].
40+
41+
* The `+dfx+` commands that support the `+--network+` option have been updated to support URLs when specifying the network value.
42+
+
43+
Previously, the `+--network+` option required you to specify a network name that matched a network aliases configured in the project's `+dfx.json+` file.
44+
45+
=== Candid
46+
47+
The Candid web interface has been updated to provide easier navigation and a better user experience.
48+
The updates to the Candid web interface include the following new features and improvements:
49+
50+
* A new Console drawer provides quick access to method output and a list of all available methods as links for fast navigation.
51+
* Canister methods and their related form elements are more clearly separated and annotated.
52+
* Method output is selectable and easier to toggle between text, UI, and JSON formats.
53+
* The layout is now responsive to provide an optimized display when viewing service using mobile devices or other media.
54+
55+
=== Motoko
56+
57+
* The {proglang} base documentation examples are now executable in the browser.
58+
59+
* The {proglang} compiler supports specifying command-line arguments using `+--args <file>+` and `+--args0 <file>+`.
60+
+
61+
The new options enable the compiler to read newline and NUL terminated arguments from a specified file name.
62+
63+
== Issues fixed in this release
64+
65+
This section covers any reported issues that have been fixed in this release.
66+
67+
== Known issues and limitations
68+
69+
This section covers any known issues or limitations that might affect how you work with the {sdk-short-name} in specific environments or scenarios.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
= Highlights of what's new in {release}
2+
:description: DFINITY Canister Software Development Kit Release Notes
3+
:proglang: Motoko
4+
:platform: Internet Computer platform
5+
:IC: Internet Computer
6+
:company-id: DFINITY
7+
:sdk-short-name: DFINITY Canister SDK
8+
:sdk-long-name: DFINITY Canister Software Development Kit (SDK)
9+
:release: 0.6.21
10+
ifdef::env-github,env-browser[:outfilesuffix:.adoc]
11+
12+
The {release} release primarily consists of changes to support new features that are not yet complete, including fixes and updates to DFX commands, {proglang}, the {proglang} base library, and Candid.
13+
14+
== New features and capabilities
15+
16+
The most significant new features and capabilities include updates in the following functional areas:
17+
18+
* <<DFX,DFX>>
19+
* <<Candid,Candid>>
20+
* <<Motoko,Motoko>>
21+
22+
=== DFX
23+
24+
* Two new subcommands—`+get-wallet+` and `+set-wallet+`—have been added to the `+dfx identity+` command to support working with wallet canisters.
25+
+
26+
In a future release, you will be able to use these commands locally for testing purposes. However, the commands are not currently supported on any version of the {IC} network available for you to run locally or on the public {IC} network.
27+
28+
=== Candid
29+
30+
* link:https://github.com/dfinity/candid/blob/master/Changelog.md[Candid changelog]
31+
32+
=== Motoko
33+
34+
* The Motoko compiler now reports errors and warnings with an additional error code.
35+
+
36+
You can use the error code to look up a more detailed description for a given error by passing the `+--explain+` flag with a code to the compiler.
37+
+
38+
Note that detailed descriptions are not yet available for most error codes and will be added incrementally in upcoming releases.
39+
40+
41+
== Issues fixed in this release
42+
43+
This section covers any reported issues that have been fixed in this release.
44+
45+
== Known issues and limitations
46+
47+
This section covers any known issues or limitations that might affect how you work with the {sdk-short-name} in specific environments or scenarios.

0 commit comments

Comments
 (0)