Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/dfinity/portal into rei/r…
Browse files Browse the repository at this point in the history
…emove-beacon
  • Loading branch information
reigj1 committed Nov 21, 2024
2 parents 7691497 + da9160b commit 30583e5
Show file tree
Hide file tree
Showing 271 changed files with 12,935 additions and 4,144 deletions.
9 changes: 9 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ docs/developer-docs/build/cdks @dfinity/dx
docs/developer-docs/integrations/rosetta @dfinity/finint
docs/developer-docs/security @dfinity/product-security
docs/references/execution-errors.mdx @dfinity/execution
docs/references/ingress-messages.mdx @dfinity/product-security
docs/references/message-execution-properties.mdx @dfinity/product-security
docs/developer-docs/web-apps/custom-domains @dfinity/boundary-node

Expand All @@ -15,5 +16,13 @@ docs/developer-docssmart-contracts/advanced-features/simd.mdx @dfinity/execution
docs/developer-docssmart-contracts/advanced-features/periodic-tasks.mdx @dfinity/execution
docs/developer-docs/smart-contracts/best-practices/idempotency.mdx @dfinity/research @dfinity/product-security

# The Interface Specification
docs/references/_attachments/certificates.cddl @dfinity/canister-os
docs/references/_attachments/http-gateway.did @dfinity/canister-os
docs/references/_attachments/ic.did @dfinity/canister-os
docs/references/_attachments/interface-spec-changelog.md @dfinity/canister-os
docs/references/_attachments/requests.cddl @dfinity/canister-os
docs/references/http-gateway-protocol-spec.md @dfinity/canister-os
docs/references/ic-interface-spec.md @dfinity/canister-os

src/pages/security-advisories.tsx @dfinity/product-security
50 changes: 50 additions & 0 deletions .github/workflows/interface-spec.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Interface Specification
on:
pull_request:
paths:
- .github/workflows/interface-spec.yml
- docs/references/http-gateway-protocol-spec.md
- docs/references/ic-interface-spec.md
- docs/references/_attachments/certificates.cddl
- docs/references/_attachments/http-gateway.did
- docs/references/_attachments/ic.did
- docs/references/_attachments/interface-spec-changelog.md
- docs/references/_attachments/requests.cddl
push:
branches:
- main
jobs:
cddl:
name: Check cddl files
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Check cddl files
run: |
docker run --rm -v $PWD/docs/references/_attachments:/workdir ghcr.io/anweiss/cddl-cli:0.9.1 compile-cddl --cddl /workdir/certificates.cddl
docker run --rm -v $PWD/docs/references/_attachments:/workdir ghcr.io/anweiss/cddl-cli:0.9.1 compile-cddl --cddl /workdir/requests.cddl
candid:
name: Check candid files
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Check candid files
run: |
curl -L https://github.com/dfinity/candid/releases/download/2023-07-25/didc-linux64 -o didc
chmod +x didc
./didc check docs/references/_attachments/http-gateway.did
./didc check docs/references/_attachments/ic.did
interface-spec-tag:
name: Tag PR with interface-spec
if: ${{ github.event_name == 'pull_request' }}
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Tag PR with interface-spec
run: |
gh pr edit ${{ github.event.pull_request.number }} --add-label interface-spec
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4 changes: 0 additions & 4 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@
path = submodules/internetidentity
url = https://github.com/dfinity/internet-identity.git
branch = main
[submodule "submodules/interface-spec"]
path = submodules/interface-spec
url = https://github.com/dfinity/interface-spec.git
branch = public
[submodule "submodules/samples"]
path = submodules/samples
url = https://github.com/dfinity/examples.git
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ docs
├── motoko // Motoko documentation - submodule
├── references // reference documentation
├── samples // sample projects - submodule
├── tutorials // tutorial series (developer journey, hackathon prep course, etc).
├── tutorials // tutorial series (developer ladder, hackathon prep course, etc).
```

# Contributing to the Dev Docs
Expand Down Expand Up @@ -155,7 +155,7 @@ Concept pages describe in more detail a specific concept of ICP. Concept pages s
Concept pages should remain simple and high-level without providing unnecessary, in-depth details. Readers should be able to quickly understand the technology and its benefits, convincing them to continue learning more and begin developing using the technology.

#### Tutorial
A tutorial uses a step-by-step format to walk a user through a specific workflow. The Developer Journey is an example of a tutorial series.
A tutorial uses a step-by-step format to walk a user through a specific workflow. The Developer Ladder is an example of a tutorial series.

#### Reference
A reference page provides low level detail into a feature or technology. API reference pages are an example that provide in-depth detail about different endpoints and methods. Some examples include:
Expand Down Expand Up @@ -394,10 +394,6 @@ The following submoules and their corresponding repos are currently used:
- `/docs/current/references/ii-spec`
- GitHub Repo: https://github.com/dfinity/internet-identity.git
- Interface Spec
- `/docs/current/references/ic-interface-spec `
- GitHub Repo: https://github.com/dfinity/interface-spec.git
- Sample projects
- `/docs/current/references/samples`
- GitHub Repo: https://github.com/dfinity/examples.git
Expand Down
2 changes: 1 addition & 1 deletion blog/features/async-performance-counter.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ image: /img/blog/async-performance-counter.webp

## Background

The Internet Computer can host a full dapp — frontend, backend and data. Users can deploy their dapp as a canister (smart contract) on the Internet Computer. Each canister can store up to 400 GB of data and execute up to 20 Billion WebAssembly instructions per transaction.
The Internet Computer can host a full dapp — frontend, backend and data. Users can deploy their dapp as a canister (smart contract) on the Internet Computer. Each canister can store up to 500GiB of data and execute up to 40 Billion WebAssembly instructions per transaction.

Unlike other blockchains, the Internet Computer offers developers [enormous amounts of resources](/docs/current/developer-docs/smart-contracts/maintain/resource-limits). This poses a real challenge for canister developers: writing efficient canister code. The more efficient a canister is, the less cycles it pays.

Expand Down
2 changes: 1 addition & 1 deletion blog/features/cycles-ledger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Today, we sat down with the team behind its development to talk about how the pr

*Our current developer base will likely be content to have a simpler workflow at their disposal. New developers will hopefully have an easy time on-boarding, which would be a great sign for us that the project made a difference.*

A huge thank you to the cycles ledger team for sitting down and giving us the inside scoop on this exciting project! We're looking forward to hearing what the community thinks about the cycles ledger on our [developer forum](https://forum.dfinity.org/) and [Discord server](https://discord.gg/jnjVVQaE2C).
A huge thank you to the cycles ledger team for sitting down and giving us the inside scoop on this exciting project! We're looking forward to hearing what the community thinks about the cycles ledger on our [developer forum](https://forum.dfinity.org/) and on [Discord](https://discord.internetcomputer.org).

Until next time!

Expand Down
2 changes: 1 addition & 1 deletion blog/features/dfx-deploy-playground.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ Since the canister has been deployed to the playground, it is important to know
- Canisters can call the management canister to manage itself without being the controller.
- Deployed canisters expire after 20 minutes.

As always, we'd love to hear your thoughts and feedback on this new feature, so please feel free to let us know through our [community forum](https://forum.dfinity.org/) or [Discord](https://discord.gg/jnjVVQaE2C) server.
As always, we'd love to hear your thoughts and feedback on this new feature, so please feel free to let us know through our [community forum](https://forum.dfinity.org/) or [Discord](https://discord.internetcomputer.org) server.

-DFINITY
10 changes: 5 additions & 5 deletions blog/news-and-updates/2023-08-16-update.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Developer weekly update August 16, 2023
description: In this issue, we're excited to introduce the first portion of a new documentation series, Developer Journey, plus talk about the upcoming `dfx` release and new documentation on the Motoko feature `mo-doc`.
description: In this issue, we're excited to introduce the first portion of a new documentation series, Developer Ladder, plus talk about the upcoming `dfx` release and new documentation on the Motoko feature `mo-doc`.
tags: [Devs]
image: /img/blog/dev-update-blog-aug-16.jpg
---
Expand All @@ -9,11 +9,11 @@ image: /img/blog/dev-update-blog-aug-16.jpg

![August 16 2023](../../static/img/blog/dev-update-blog-aug-16.jpg)

Hey developers! Welcome to this week's developer weekly update. In this issue, we're excited to introduce the first portion of a new documentation series: Developer Journey, plus talk about the upcoming `dfx` release and new documentation on the Motoko feature `mo-doc`.
Hey developers! Welcome to this week's developer weekly update. In this issue, we're excited to introduce the first portion of a new documentation series: Developer Ladder, plus talk about the upcoming `dfx` release and new documentation on the Motoko feature `mo-doc`.

## Introducing the Developer Journey
## Introducing the Developer Ladder

Today we're excited to introduce the new Developer Journey tutorial series! This series is designed to bring new developers on a detailed, diverse journey through development on the Internet Computer. The journey starts with 'pre-flight operations', which is an introductory level that provides context for the remainder of the journey, such as an overview of what ICP is, how it works, and how to set up your developer environment. Then, the journey will bring you through a series of modules to develop your skills and learn about additional ICP components in order to become an ICP astronaut!
Today we're excited to introduce the new Developer Ladder tutorial series! This series is designed to bring new developers on a detailed, diverse journey through development on the Internet Computer. The journey starts with 'pre-flight operations', which is an introductory level that provides context for the remainder of the journey, such as an overview of what ICP is, how it works, and how to set up your developer environment. Then, the journey will bring you through a series of modules to develop your skills and learn about additional ICP components in order to become an ICP astronaut!

Overall, the journey will contain the following modules and components:

Expand Down Expand Up @@ -101,7 +101,7 @@ Overall, the journey will contain the following modules and components:

- 5.6: Next steps.

The first portion of this series, Level 0: Pre-flight operations, is out now and ready for you to follow along with! You can get started with your developer journey [here](https://internetcomputer.org/docs/current/tutorials/developer-journey/level-0/).
The first portion of this series, Level 0: Pre-flight operations, is out now and ready for you to follow along with! You can get started with the Developer Ladder [here](https://internetcomputer.org/docs/current/tutorials/developer-journey/level-0/).

## Upcoming `dfx 0.15` release

Expand Down
10 changes: 5 additions & 5 deletions blog/news-and-updates/2023-09-06-update.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Developer weekly update September 6, 2023
description: This week, we're excited to talk about the next installment of the new documentation series developer journey, plus talk about upcoming features and integrations such as the Ethereum integration and the cycles ledger.
description: This week, we're excited to talk about the next installment of the new documentation series Developer ladder, plus talk about upcoming features and integrations such as the Ethereum integration and the cycles ledger.
tags: [Devs]
image: /img/blog/dev-update-blog-sept-6.jpg
---
Expand All @@ -9,13 +9,13 @@ image: /img/blog/dev-update-blog-sept-6.jpg

![September 6 2023](../../static/img/blog/dev-update-blog-sept-6.jpg)

Hello devs and welcome to this week's issue of developer weekly! This week, we're excited to talk about the next installment of the new documentation series developer journey, plus talk about upcoming features and integrations such as the Ethereum integration and the cycles ledger.
Hello devs and welcome to this week's issue of developer weekly! This week, we're excited to talk about the next installment of the new documentation series developer ladder, plus talk about upcoming features and integrations such as the Ethereum integration and the cycles ledger.

Let's get into it!

## Developer journey level 1
## Developer ladder level 1

The second level of the developer journey tutorial series is now live on the developer docs! In this level, level 1, we begin to dive into the building blocks of developing on ICP, such as learning about Motoko fundamentals, developing a simple poll dapp, and learning about canister deployment and management. Modules in this level include:
The second level of the developer ladder tutorial series is now live on the developer docs! In this level, level 1, we begin to dive into the building blocks of developing on ICP, such as learning about Motoko fundamentals, developing a simple poll dapp, and learning about canister deployment and management. Modules in this level include:

- [1.1: Exploring a live demo](/docs/current/tutorials/developer-journey/level-1/1.1-live-demo):

Expand Down Expand Up @@ -90,7 +90,7 @@ In this module, you can learn about:
- Setting the canister's freezing threshold.
- Deleting a canister.

You can learn more about the developer journey and get started with level 0 in the [tutorials section of our developer documentation](/docs/current/tutorials/developer-journey/).
You can learn more about the developer ladder and get started with level 0 in the [tutorials section of our developer documentation](/docs/current/tutorials/developer-journey/).

## Ethereum starter project

Expand Down
4 changes: 2 additions & 2 deletions blog/news-and-updates/2023-09-13-update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ Want to get started? The interactive tutorial can be found in our Motoko documen

Over the past few weeks, we've had some great new pages added to our developer documentation. Let's take a look at some of the new additions!

- [Developer journey level 0](/docs/current/tutorials/developer-journey/level-0/): Start your developer journey at the very beginning by following the level 0 module. In level 0, we cover the fundamentals of what the Internet Computer is, what terms you should be familiar with, and what tools we'll be using throughout our journey.
- [Developer ladder level 0](/docs/current/tutorials/developer-journey/level-0/): Start the developer ladder at the very beginning by following the level 0 module. In level 0, we cover the fundamentals of what the Internet Computer is, what terms you should be familiar with, and what tools we'll be using throughout our journey.

- [Developer journey level 1](/docs/current/tutorials/developer-journey/level-1/): In the next stage of the developer journey, become a space cadet by getting comfortable creating your first dapp, managing your canisters, and acquiring and using cycles.
- [Developer ladder level 1](/docs/current/tutorials/developer-journey/level-1/): In the next stage of the developer ladder, become a space cadet by getting comfortable creating your first dapp, managing your canisters, and acquiring and using cycles.

- [Pulling canister dependencies](/docs/current/developer-docs/smart-contracts/maintain/import): Learn how to use the new `dfx deps` feature to pull third-party canister dependencies.

Expand Down
Loading

0 comments on commit 30583e5

Please sign in to comment.