From 2e8fa6d3c390e224e8f5e3c28c8ea50625fcbcfa Mon Sep 17 00:00:00 2001 From: kianenigma Date: Tue, 27 Aug 2024 12:39:04 +0100 Subject: [PATCH 1/8] bold steps towards deprecation --- .netlify/_redirects | 2 +- content/config/nav.yaml | 29 ++-- .../md/en/docs/examples/quickstart/index.html | 18 +-- content/md/en/docs/polkadot-sdk/index.md | 37 +++++ .../md/en/homepage/get-started-homepage.md | 2 + .../md/en/homepage/get-technical-homepage.md | 2 + content/md/en/homepage/hands-on-homepage.md | 2 + src/pages/index.js | 65 ++++++-- src/styles/scss/_home.scss | 146 +++++++++++++++++- static/assets/quickstart/index.html | 18 +-- 10 files changed, 276 insertions(+), 45 deletions(-) create mode 100644 content/md/en/docs/polkadot-sdk/index.md diff --git a/.netlify/_redirects b/.netlify/_redirects index afda3f68c..3aee51a1c 100644 --- a/.netlify/_redirects +++ b/.netlify/_redirects @@ -1,6 +1,6 @@ # Redirects from what the browser requests to what we serve -/rustdocs https://paritytech.github.io/substrate/master/sc_service/ 301! +/rustdocs https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html 301! /how-to-guides /reference/ 301! diff --git a/content/config/nav.yaml b/content/config/nav.yaml index 699a0cb11..d148624cc 100644 --- a/content/config/nav.yaml +++ b/content/config/nav.yaml @@ -1,4 +1,5 @@ menu: + - polkadot-sdk - quick-start - learn - install @@ -10,8 +11,12 @@ menu: - reference - community +polkadot-sdk: + title: Substrate -> Polkadot SDK + url: /polkadot-sdk/ + quick-start: - title: Quick start + title: Quick start (Deprecated) url: /quick-start/ pages: - title: Substrate at a glance @@ -24,7 +29,7 @@ quick-start: url: /quick-start/modify-the-runtime/ learn: - title: Learn + title: Learn (Deprecated) url: /learn/ pages: - title: Welcome to Substrate @@ -69,7 +74,7 @@ learn: url: /learn/xcm-communication/ install: - title: Install + title: Install (Deprecated) url: /install/ pages: - title: Rust toolchain @@ -84,7 +89,7 @@ install: url: /install/developer-tools/ - title: Troubleshoot Rust issues url: /install/troubleshoot-rust-issues/ - + #design: # title: Design # url: /design/ @@ -106,7 +111,7 @@ install: #- title: Economic models #url: /design/economic-models/ build: - title: Build + title: Build (Deprecated) url: /build/ pages: - title: Smart contracts @@ -143,7 +148,7 @@ build: #url: /build/executor/ test: - title: Test + title: Test (Deprecated) url: /test/ pages: - title: Unit test @@ -156,9 +161,9 @@ test: url: /test/simulate-parachains/ - title: Check runtime url: /test/check-runtime/ - + deploy: - title: Deploy + title: Deploy (Deprecated) url: /deploy/ pages: - title: Prepare to deploy @@ -174,7 +179,7 @@ deploy: # - title: Launch a parachain # url: /deploy/launch-a-parachain/ maintain: - title: Maintain + title: Maintain (Deprecated) url: /maintain/ pages: - title: Monitor @@ -191,7 +196,7 @@ maintain: # url: /maintain/data-migration/ tutorials: - title: Tutorials + title: Tutorials (Deprecated) url: /tutorials/ pages: - title: Build a blockchain @@ -282,7 +287,7 @@ tutorials: # url: /tutorials/integrate-with-tools/access-evm-accounts/ reference: - title: Reference + title: Reference (Deprecated) url: /reference/ pages: - title: Rust API @@ -335,7 +340,7 @@ reference: url: /reference/how-to-guides/ community: - title: Community + title: Community (Deprecated) url: /community/ pages: - title: Content style guide diff --git a/content/md/en/docs/examples/quickstart/index.html b/content/md/en/docs/examples/quickstart/index.html index 26839f0df..013743a9c 100644 --- a/content/md/en/docs/examples/quickstart/index.html +++ b/content/md/en/docs/examples/quickstart/index.html @@ -20,36 +20,36 @@ } - +

Display an account balance

Enter a development account address, then click Get Balance.

- +

Balance: Not Connected

- + - + - \ No newline at end of file + diff --git a/content/md/en/docs/polkadot-sdk/index.md b/content/md/en/docs/polkadot-sdk/index.md new file mode 100644 index 000000000..940b70ecb --- /dev/null +++ b/content/md/en/docs/polkadot-sdk/index.md @@ -0,0 +1,37 @@ +--- +title: Polkadot SDK +description: +keywords: + - polkadot-sdk +--- + + +## Substrate to Polkadot SDK + +In [May +2023](https://forum.polkadot.network/t/psa-parity-is-currently-working-on-merging-the-polkadot-stack-repositories-into-one-single-repository/2883), +Parity Technologies started moving 3 repositories of +[`substrate`](https://github.com/paritytech/substrate), +[`polkadot`](https://github.com/paritytech/polkadot), and +[`cumulus`](https://github.com/paritytech/cumulus), formerly independent in development and +branding, under one mew mono-repo called +[`polkadot-sdk`](https://github.com/paritytech/polkadot-sdk). Consequently, the [runtimes of the +Polkadot and Kusama relay chains, and their system chain](https://github.com/polkadot-fellows/runtimes) were moved to be maintained by the [Polkadot fellowship](polkadot-fellows.github.io/dashboard/). + +This transition gave birth to a new vision in which these tools are seen from lense of being part of `polkadot-sdk`, while still being independently useful. + +Most impacted in this transition is **Substrate**, and part of this impact is gradual deprecation of +this website. The content in this website is no longer maintained, and will be gradually moved to a +new home. Consider the following resources as primary sources of information. + +Note that **this does not impact the development of Substrate as a framework**. Substrate, as a framework, is still being maintained with full steam as a part of polkadot-sdk, and retains its full ability to be used to build both [standalone blockchains](https://github.com/paritytech/polkadot-sdk-solochain-template), or [Polkadot powered parachains](https://github.com/paritytech/polkadot-sdk-parachain-template). + +## Alternative Resources + +Below, you can find a number of replacement resources to learn more about Polkadot SDK: + +- [Polkadot Wiki](https://wiki.polkadot.network/) +- [Polkadot Developers](https://github.com/polkadot-developers/) +- [Polkadot Blockchain Academy](https://academy.polkadot.network/) +- [Polkadot Ecosystem Documentation by Papermoon](https://wiki.polkadot.network/) +- [Polkadot SDK Rust Docs](https://wiki.polkadot.network/) diff --git a/content/md/en/homepage/get-started-homepage.md b/content/md/en/homepage/get-started-homepage.md index 056789623..061195f07 100644 --- a/content/md/en/homepage/get-started-homepage.md +++ b/content/md/en/homepage/get-started-homepage.md @@ -10,4 +10,6 @@ bodyLinkTwoTitle: Blockchain basics bodyLinkTwoURL: /learn/blockchain-basics/ bodyLinkThreeTitle: Architecture and Rust libraries bodyLinkThreeURL: /learn/architecture/ +bodyLinkFourTitle: +bodyLinkFourURL: --- diff --git a/content/md/en/homepage/get-technical-homepage.md b/content/md/en/homepage/get-technical-homepage.md index f4af3a8a3..fe24257bf 100644 --- a/content/md/en/homepage/get-technical-homepage.md +++ b/content/md/en/homepage/get-technical-homepage.md @@ -10,4 +10,6 @@ bodyLinkTwoTitle: Rust for Substrate bodyLinkTwoURL: /learn/rust-basics/ bodyLinkThreeTitle: Command-line tools bodyLinkThreeURL: /reference/command-line-tools/ +bodyLinkFourTitle: +bodyLinkFourURL: --- diff --git a/content/md/en/homepage/hands-on-homepage.md b/content/md/en/homepage/hands-on-homepage.md index 09051ed12..459a9a75a 100644 --- a/content/md/en/homepage/hands-on-homepage.md +++ b/content/md/en/homepage/hands-on-homepage.md @@ -10,4 +10,6 @@ bodyLinkTwoTitle: Simulate a network bodyLinkTwoURL: /tutorials/build-a-blockchain/simulate-network/ bodyLinkThreeTitle: Add a pallet bodyLinkThreeURL: /tutorials/build-application-logic/add-a-pallet/ +bodyLinkFourTitle: +bodyLinkFourURL: --- diff --git a/src/pages/index.js b/src/pages/index.js index 0336af5aa..28a88da78 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -2,26 +2,45 @@ import { graphql } from 'gatsby'; import { Layout, Section, SEO } from 'gatsby-plugin-substrate'; import React from 'react'; -import CardsList from '../components/layout/Documentation/CardList'; -import SearchDocumentation from '../components/ui/SearchDocumentation'; +import Card from '../components/layout/Documentation/Card'; +// import CardsList from '../components/layout/Documentation/CardList'; +// import SearchDocumentation from '../components/ui/SearchDocumentation'; export default function Home({ data }) { - const { content } = data; + // eslint-disable-next-line no-empty-pattern + const {} = data; return ( -
-

Substrate Documentation

-
-

- Substrate documentation includes conceptual, procedural, and reference information for blockchain builders - and parachain project teams. -

-
- +
+

Substrate

+

Is now part of

+

+ Polkadot SDK +

- +
); @@ -38,6 +57,26 @@ export const query = graphql` } } } + goodbye: allMarkdownRemark(filter: { fileAbsolutePath: { regex: "/homepage/goodbye.md$/" } }) { + edges { + node { + id + frontmatter { + title + link + order + description + bodyLinkOneURL + bodyLinkOneTitle + bodyLinkTwoURL + bodyLinkTwoTitle + bodyLinkThreeURL + bodyLinkThreeTitle + featured_image + } + } + } + } content: allMarkdownRemark(filter: { fileAbsolutePath: { regex: "//(homepage)/" } }) { edges { node { diff --git a/src/styles/scss/_home.scss b/src/styles/scss/_home.scss index 4f63d0944..7951a236c 100644 --- a/src/styles/scss/_home.scss +++ b/src/styles/scss/_home.scss @@ -135,6 +135,150 @@ transition: 0.33s; } +@import url('https://fonts.googleapis.com/css2?family=Unbounded:wght@200..900&display=swap'); + +@keyframes wobbleFade { + 0% { + transform: translate(0, 0) rotate(0deg); + opacity: 1; + text-shadow: 0px 5px 30px #24CC85; + } + 5% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.95; + text-shadow: 0px 5px 33px #24CC85; + } + 10% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.9; + text-shadow: 0px 5px 36px #24CC85; + } + 15% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.85; + text-shadow: 0px 5px 39px #24CC85; + } + 20% { + transform: translate(3px, 3px) rotate(1deg); + opacity: 0.8; + text-shadow: 0px 5px 42px #24CC85; + } + 25% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.75; + text-shadow: 0px 5px 45px #24CC85; + } + 30% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.7; + text-shadow: 0px 5px 48px #24CC85; + } + 35% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.65; + text-shadow: 0px 5px 51px #24CC85; + } + 40% { + transform: translate(3px, 3px) rotate(1deg); + opacity: 0.6; + text-shadow: 0px 5px 54px #24CC85; + } + 45% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.55; + text-shadow: 0px 5px 57px #24CC85; + } + 50% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.5; + text-shadow: 0px 5px 60px #24CC85; + } + 55% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.45; + text-shadow: 0px 5px 60px #24CC85; + } + 60% { + transform: translate(3px, 3px) rotate(1deg); + opacity: 0.4; + text-shadow: 0px 5px 60px #24CC85; + } + 65% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.35; + text-shadow: 0px 5px 60px #24CC85; + } + 70% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 75% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 80% { + transform: translate(3px, 3px) rotate(1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 85% { + transform: translate(-3px, -3px) rotate(-1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 90% { + transform: translate(3px, -3px) rotate(1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 95% { + transform: translate(-3px, 3px) rotate(-1deg); + opacity: 0.3; + text-shadow: 0px 5px 60px #24CC85; + } + 100% { + transform: translate(0, 0) rotate(0deg); + opacity: 0.3; /* End at 0.3 opacity */ + text-shadow: 0px 5px 60px #24CC85; /* End at 60px spread */ + } +} + +.substrate { + animation: wobbleFade 10s forwards; /* Use forwards to retain the final state */ + text-shadow: 0px 5px 30px #24CC85; +} + +.polkadot-sdk { + font-family: "Unbounded"; +} + +.underline-effect { + position: relative; + display: inline-block; + color: white; /* Base text color */ +} + +.underline-effect::after { + content: ''; + position: absolute; + width: 100%; + height: 5px; /* Thickness of the underline */ + top: 60px; + bottom: 0; + left: 0; + background-color: #e6007a; /* Color of the underline */ + transform: scaleX(0); + transform-origin: bottom right; + transition: transform 0.3s ease-out; +} + +.underline-effect:hover::after { + transform: scaleX(1); + transform-origin: bottom left; +} + /* Hide scrollbar on windows */ .nav-sidebar { @@ -181,7 +325,7 @@ pre { margin: 1rem 0 2rem 0; } -/* Code View */ +/* Code View */ .markdown-body a.anchor { display:none; } diff --git a/static/assets/quickstart/index.html b/static/assets/quickstart/index.html index 26839f0df..013743a9c 100644 --- a/static/assets/quickstart/index.html +++ b/static/assets/quickstart/index.html @@ -20,36 +20,36 @@ } - +

Display an account balance

Enter a development account address, then click Get Balance.

- +

Balance: Not Connected

- + - + - \ No newline at end of file + From 62ad9b142f2761cfb52c000e1d29a73bea2ca782 Mon Sep 17 00:00:00 2001 From: kianenigma Date: Tue, 27 Aug 2024 13:10:48 +0100 Subject: [PATCH 2/8] update --- .../md/en/docs/build/genesis-configuration.md | 21 ++++++++++++------- content/md/en/docs/build/origins.md | 2 +- content/md/en/docs/build/pallet-coupling.md | 7 +------ .../en/docs/build/remote-procedure-calls.md | 2 +- .../md/en/docs/learn/offchain-operations.md | 7 +------ content/md/en/docs/polkadot-sdk/index.md | 4 +++- content/md/en/docs/reference/frame-macros.md | 2 +- .../how-to-guides/offchain-workers/index.md | 7 +------ .../offchain-http-requests.md | 7 +------ .../offchain-workers/offchain-indexing.md | 7 +------ .../offchain-local-storage.md | 7 +------ .../pallet-design/use-loose-coupling.md | 7 +------ .../pallet-design/use-tight-coupling.md | 7 +------ content/md/en/docs/reference/xcm-reference.md | 7 +------ .../add-offchain-workers.md | 7 +------ .../explore-sidecar-endpoints.md | 5 ----- src/templates/single.js | 13 ++++++++++++ 17 files changed, 42 insertions(+), 77 deletions(-) diff --git a/content/md/en/docs/build/genesis-configuration.md b/content/md/en/docs/build/genesis-configuration.md index f398bcb92..7375600d9 100644 --- a/content/md/en/docs/build/genesis-configuration.md +++ b/content/md/en/docs/build/genesis-configuration.md @@ -5,7 +5,7 @@ keywords: ---
- ⚠️ WARNING: This page contains outdated information. Please refer to the Rust docs for the most up-to-date documentation on this topic. + Please refer to the Rust docs for the most up-to-date documentation on this topic.
@@ -19,7 +19,7 @@ As you learned in [Chain specification](/build/chain-spec/), the chain specifica However, the chain specification doesn't create the storage items that get initialized when you start a node. Instead, the storage items are defined in the pallets included in the runtime as described in [Runtime storage](/build/runtime-storage/). -After you create storage items for the runtime, you can choose whether they should be set to some initial value as part of the genesis configuration and included in the genesis block. +After you create storage items for the runtime, you can choose whether they should be set to some initial value as part of the genesis configuration and included in the genesis block. To specify the storage items that you want to set an initial state for, Substrate provides two specialized FRAME attribute macros. The macros you can use to initialize storage items as part of the genesis configuration for a chain are: @@ -120,12 +120,17 @@ All of the `GenesisConfig` types for the pallets that included in the constructi The aggregated `RuntimeGenesisConfig` implements the [`BuildStorage`](https://paritytech.github.io/substrate/master/sp_runtime/trait.BuildStorage.html) trait to build all of the initial storage items for the runtime. For example, the node template runtime builds storage items for the following pallets that have a `RuntimeGenesisConfig` specified by default: -- [System pallet](#system-pallet) -- [Aura pallet](#aura-pallet) -- [Grandpa pallet](#grandpa-pallet) -- [Balances pallet](#balances-pallet) -- [TransactionPayment pallet](#transactionpayment-pallet) -- [Sudo pallet](#sudo-pallet) +- [Configure a simple storage value](#configure-a-simple-storage-value) + - [Configure macros in the pallet](#configure-macros-in-the-pallet) + - [Configure the chain specification](#configure-the-chain-specification) +- [Adding genesis configuration to the runtime](#adding-genesis-configuration-to-the-runtime) + - [System pallet](#system-pallet) + - [Aura pallet](#aura-pallet) + - [Grandpa pallet](#grandpa-pallet) + - [Balances pallet](#balances-pallet) + - [TransactionPayment pallet](#transactionpayment-pallet) + - [Sudo pallet](#sudo-pallet) +- [Initialize storage items within a pallet](#initialize-storage-items-within-a-pallet) ### System pallet diff --git a/content/md/en/docs/build/origins.md b/content/md/en/docs/build/origins.md index 66d4da804..428755e91 100644 --- a/content/md/en/docs/build/origins.md +++ b/content/md/en/docs/build/origins.md @@ -6,7 +6,7 @@ keywords: ---
- ⚠️ WARNING: This page contains outdated information. Please refer to the Rust docs for the most up-to-date documentation on this topic. + Please refer to the Rust docs for the most up-to-date documentation on this topic.
The runtime origin is used by dispatchable functions to check where a call has come from. diff --git a/content/md/en/docs/build/pallet-coupling.md b/content/md/en/docs/build/pallet-coupling.md index 9e900a4bc..7e0d17672 100644 --- a/content/md/en/docs/build/pallet-coupling.md +++ b/content/md/en/docs/build/pallet-coupling.md @@ -7,12 +7,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
The term **coupling** is often used to describe the degree to which two software modules depend on each other. diff --git a/content/md/en/docs/build/remote-procedure-calls.md b/content/md/en/docs/build/remote-procedure-calls.md index ec2e49c23..896c954ae 100644 --- a/content/md/en/docs/build/remote-procedure-calls.md +++ b/content/md/en/docs/build/remote-procedure-calls.md @@ -7,7 +7,7 @@ keywords: ---
- ⚠️ WARNING: This page may contain outdated information. Please refer to the Rust docs for the most up-to-date documentation on this topic. + Please refer to the Rust docs for the most up-to-date documentation on this topic.
Remote procedure calls, or RPC methods, are a way for an external program—for example, a browser or front-end application—to communicate with a Substrate node. diff --git a/content/md/en/docs/learn/offchain-operations.md b/content/md/en/docs/learn/offchain-operations.md index 2161626d1..b34213aff 100644 --- a/content/md/en/docs/learn/offchain-operations.md +++ b/content/md/en/docs/learn/offchain-operations.md @@ -5,12 +5,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
There are many use cases where you might want to query data from an offchain source or process data without using on-chain resources before updating the on-chain state. diff --git a/content/md/en/docs/polkadot-sdk/index.md b/content/md/en/docs/polkadot-sdk/index.md index 940b70ecb..cc0b12ddf 100644 --- a/content/md/en/docs/polkadot-sdk/index.md +++ b/content/md/en/docs/polkadot-sdk/index.md @@ -22,7 +22,9 @@ This transition gave birth to a new vision in which these tools are seen from le Most impacted in this transition is **Substrate**, and part of this impact is gradual deprecation of this website. The content in this website is no longer maintained, and will be gradually moved to a -new home. Consider the following resources as primary sources of information. +new home. Consider the [resources below](#alternative-resources) as primary sources of information. + +> You may still access the old content of this website in the navbar, but be aware of the fact that some content might not be up to date. Note that **this does not impact the development of Substrate as a framework**. Substrate, as a framework, is still being maintained with full steam as a part of polkadot-sdk, and retains its full ability to be used to build both [standalone blockchains](https://github.com/paritytech/polkadot-sdk-solochain-template), or [Polkadot powered parachains](https://github.com/paritytech/polkadot-sdk-parachain-template). diff --git a/content/md/en/docs/reference/frame-macros.md b/content/md/en/docs/reference/frame-macros.md index 800ebd726..07e37923f 100644 --- a/content/md/en/docs/reference/frame-macros.md +++ b/content/md/en/docs/reference/frame-macros.md @@ -4,7 +4,7 @@ description: keywords: ---
- ⚠️ WARNING: This section contains outdated information. Please refer to the Rust docs for the most up-to-date documentation on this topic. + Please refer to the Rust docs for the most up-to-date documentation on this topic.
Substrate uses customized [Rust macros](https://doc.rust-lang.org/book/ch19-06-macros.html) to generate code and aggregate the logic from the pallets you implement for a runtime. diff --git a/content/md/en/docs/reference/how-to-guides/offchain-workers/index.md b/content/md/en/docs/reference/how-to-guides/offchain-workers/index.md index 5b93d9815..d064aa973 100644 --- a/content/md/en/docs/reference/how-to-guides/offchain-workers/index.md +++ b/content/md/en/docs/reference/how-to-guides/offchain-workers/index.md @@ -5,12 +5,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
The _How-to_ guides in the _Offchain workers_ category illustrate common use cases for offchain operations. diff --git a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-http-requests.md b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-http-requests.md index d49818e6e..1e396ae32 100644 --- a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-http-requests.md +++ b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-http-requests.md @@ -10,12 +10,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
Because most blockchains can't access data that's hosted on servers outside of their own network, they typically use external third-party services—**oracles**—to pull information in from or push information out to locations that are outside of the network. diff --git a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-indexing.md b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-indexing.md index acfb76126..abe0f791e 100644 --- a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-indexing.md +++ b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-indexing.md @@ -8,12 +8,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This guide will step you through how to pass data from an extrinsic to an offchain worker without writing to storage. diff --git a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-local-storage.md b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-local-storage.md index b5d0ebf9f..ba6290b77 100644 --- a/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-local-storage.md +++ b/content/md/en/docs/reference/how-to-guides/offchain-workers/offchain-local-storage.md @@ -9,12 +9,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This guide will teach you how to use an offchain worker to save retrieved data in local storage for future access. diff --git a/content/md/en/docs/reference/how-to-guides/pallet-design/use-loose-coupling.md b/content/md/en/docs/reference/how-to-guides/pallet-design/use-loose-coupling.md index 0c9ae3286..15ab0f4f8 100644 --- a/content/md/en/docs/reference/how-to-guides/pallet-design/use-loose-coupling.md +++ b/content/md/en/docs/reference/how-to-guides/pallet-design/use-loose-coupling.md @@ -5,12 +5,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This guide demonstrates how to reuse a function or type from one pallet in another pallet using a technique called **loose coupling**. diff --git a/content/md/en/docs/reference/how-to-guides/pallet-design/use-tight-coupling.md b/content/md/en/docs/reference/how-to-guides/pallet-design/use-tight-coupling.md index c2031b9ac..2889fb20d 100644 --- a/content/md/en/docs/reference/how-to-guides/pallet-design/use-tight-coupling.md +++ b/content/md/en/docs/reference/how-to-guides/pallet-design/use-tight-coupling.md @@ -5,12 +5,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
Tight coupling two pallets is a technique to write pallets that re-use types and methods from an existing pallet. diff --git a/content/md/en/docs/reference/xcm-reference.md b/content/md/en/docs/reference/xcm-reference.md index 74ba23bc0..839bc338f 100644 --- a/content/md/en/docs/reference/xcm-reference.md +++ b/content/md/en/docs/reference/xcm-reference.md @@ -9,12 +9,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This section provides reference information for the cross-consensus message (XCM) format. diff --git a/content/md/en/docs/tutorials/build-application-logic/add-offchain-workers.md b/content/md/en/docs/tutorials/build-application-logic/add-offchain-workers.md index a7b1ced2c..68aec308e 100644 --- a/content/md/en/docs/tutorials/build-application-logic/add-offchain-workers.md +++ b/content/md/en/docs/tutorials/build-application-logic/add-offchain-workers.md @@ -12,12 +12,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

- Please refer to the `polkadot-sdk-docs` crate for the most up-to-date documentation on this topic. -

+ Please refer to the Rust Docs for the most up-to-date documentation on this topic.
This tutorial illustrates how to modify a pallet to include an offchain worker and configure the pallet and runtime to enable the offchain worker to submit transactions that update the on-chain state. diff --git a/content/md/en/docs/tutorials/integrate-with-tools/explore-sidecar-endpoints.md b/content/md/en/docs/tutorials/integrate-with-tools/explore-sidecar-endpoints.md index 83aa665f9..0153ad29a 100644 --- a/content/md/en/docs/tutorials/integrate-with-tools/explore-sidecar-endpoints.md +++ b/content/md/en/docs/tutorials/integrate-with-tools/explore-sidecar-endpoints.md @@ -5,12 +5,7 @@ keywords: ---
-

- ⚠️ WARNING: This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt. -

-

Please refer to the Sidecar docs, the README and the guides folder for the most up-to-date documentation on this topic. -

The Substrate [sidecar](https://github.com/paritytech/substrate-api-sidecar) service provides a REST API for interacting with Substrate blockchain nodes built using FRAME. diff --git a/src/templates/single.js b/src/templates/single.js index e6d3fc49d..1d999e8e2 100644 --- a/src/templates/single.js +++ b/src/templates/single.js @@ -1,3 +1,4 @@ +import { useLocation } from '@reach/router'; import { graphql } from 'gatsby'; import { Layout, Link, SEO } from 'gatsby-plugin-substrate'; import React from 'react'; @@ -20,6 +21,8 @@ export default function DocsSinglePage({ data, pageContext }) { const { gitLogLatestDate } = data.markdownRemark.parent.fields != null ? data.markdownRemark.parent.fields : ''; //const pagePathNoSlash = pagePath.endsWith('/') ? pagePath.slice(0, -1) : pagePath; const relativeFilePath = data.markdownRemark.parent.relativePath; + const location = useLocation(); // Get the current location + function titleize(slug) { let words = slug.toLowerCase().replace(/-/g, ' '); words = words[0].toUpperCase() + words.substring(1); @@ -102,6 +105,16 @@ export default function DocsSinglePage({ data, pageContext }) {

{title}

+ {location.pathname !== '/polkadot-sdk' && ( +
+ ⚠️ Deprecation Notice: +

+ + Please read Substrate to Polkadot SDK page first. + +

+
+ )}
From a0306a435c88fdf89c782f11fcc8df6c44e0d0d3 Mon Sep 17 00:00:00 2001 From: kianenigma Date: Tue, 27 Aug 2024 13:11:07 +0100 Subject: [PATCH 3/8] remoe unused --- src/pages/index.js | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/src/pages/index.js b/src/pages/index.js index 28a88da78..f503f7b11 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -57,26 +57,6 @@ export const query = graphql` } } } - goodbye: allMarkdownRemark(filter: { fileAbsolutePath: { regex: "/homepage/goodbye.md$/" } }) { - edges { - node { - id - frontmatter { - title - link - order - description - bodyLinkOneURL - bodyLinkOneTitle - bodyLinkTwoURL - bodyLinkTwoTitle - bodyLinkThreeURL - bodyLinkThreeTitle - featured_image - } - } - } - } content: allMarkdownRemark(filter: { fileAbsolutePath: { regex: "//(homepage)/" } }) { edges { node { From 236abd4807229b3a2ed31ff93931cce9839211ee Mon Sep 17 00:00:00 2001 From: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:12:33 +0100 Subject: [PATCH 4/8] Apply suggestions from code review Co-authored-by: Radha <86818441+DrW3RK@users.noreply.github.com> --- content/md/en/docs/polkadot-sdk/index.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/content/md/en/docs/polkadot-sdk/index.md b/content/md/en/docs/polkadot-sdk/index.md index cc0b12ddf..df2e4949d 100644 --- a/content/md/en/docs/polkadot-sdk/index.md +++ b/content/md/en/docs/polkadot-sdk/index.md @@ -14,14 +14,14 @@ Parity Technologies started moving 3 repositories of [`substrate`](https://github.com/paritytech/substrate), [`polkadot`](https://github.com/paritytech/polkadot), and [`cumulus`](https://github.com/paritytech/cumulus), formerly independent in development and -branding, under one mew mono-repo called +branding, under one new mono-repo called [`polkadot-sdk`](https://github.com/paritytech/polkadot-sdk). Consequently, the [runtimes of the -Polkadot and Kusama relay chains, and their system chain](https://github.com/polkadot-fellows/runtimes) were moved to be maintained by the [Polkadot fellowship](polkadot-fellows.github.io/dashboard/). +Polkadot and Kusama relay chains, and their system chains](https://github.com/polkadot-fellows/runtimes) were moved to be maintained by the [Polkadot fellowship](polkadot-fellows.github.io/dashboard/). -This transition gave birth to a new vision in which these tools are seen from lense of being part of `polkadot-sdk`, while still being independently useful. +This transition gave birth to a new vision in which these tools are seen from the lens of being part of `polkadot-sdk` while still being independently useful. -Most impacted in this transition is **Substrate**, and part of this impact is gradual deprecation of -this website. The content in this website is no longer maintained, and will be gradually moved to a +Most impacted in this transition is **Substrate**, and part of this impact is the gradual deprecation of +this website. The content on this website is no longer maintained and will be gradually moved to a new home. Consider the [resources below](#alternative-resources) as primary sources of information. > You may still access the old content of this website in the navbar, but be aware of the fact that some content might not be up to date. @@ -32,8 +32,8 @@ Note that **this does not impact the development of Substrate as a framework**. Below, you can find a number of replacement resources to learn more about Polkadot SDK: -- [Polkadot Wiki](https://wiki.polkadot.network/) +- [Polkadot Wiki](https://wiki.polkadot.network/docs/build-guide) - [Polkadot Developers](https://github.com/polkadot-developers/) -- [Polkadot Blockchain Academy](https://academy.polkadot.network/) -- [Polkadot Ecosystem Documentation by Papermoon](https://wiki.polkadot.network/) -- [Polkadot SDK Rust Docs](https://wiki.polkadot.network/) +- [Polkadot Blockchain Academy](https://polkadot.com/blockchain-academy) +- Polkadot Ecosystem Documentation by Papermoon (Work in progress) +- [Polkadot SDK Rust Docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html) From fffff45806b67a8262112cce3bd64e222790a32a Mon Sep 17 00:00:00 2001 From: kianenigma Date: Tue, 27 Aug 2024 15:19:24 +0100 Subject: [PATCH 5/8] nits --- content/config/nav.yaml | 2 +- src/pages/index.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/config/nav.yaml b/content/config/nav.yaml index d148624cc..9cd4998a4 100644 --- a/content/config/nav.yaml +++ b/content/config/nav.yaml @@ -12,7 +12,7 @@ menu: - community polkadot-sdk: - title: Substrate -> Polkadot SDK + title: Substrate to Polkadot SDK url: /polkadot-sdk/ quick-start: diff --git a/src/pages/index.js b/src/pages/index.js index f503f7b11..33154b4f1 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -31,7 +31,7 @@ export default function Home({ data }) {
Date: Tue, 27 Aug 2024 20:51:08 +0100 Subject: [PATCH 6/8] Update content/md/en/docs/polkadot-sdk/index.md Co-authored-by: bader y --- content/md/en/docs/polkadot-sdk/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/md/en/docs/polkadot-sdk/index.md b/content/md/en/docs/polkadot-sdk/index.md index df2e4949d..813d2ff58 100644 --- a/content/md/en/docs/polkadot-sdk/index.md +++ b/content/md/en/docs/polkadot-sdk/index.md @@ -10,7 +10,7 @@ keywords: In [May 2023](https://forum.polkadot.network/t/psa-parity-is-currently-working-on-merging-the-polkadot-stack-repositories-into-one-single-repository/2883), -Parity Technologies started moving 3 repositories of +Parity Technologies started moving the three repositories that contained [`substrate`](https://github.com/paritytech/substrate), [`polkadot`](https://github.com/paritytech/polkadot), and [`cumulus`](https://github.com/paritytech/cumulus), formerly independent in development and From f0073d134aac425d6a376f6bc091db0bc6ad6624 Mon Sep 17 00:00:00 2001 From: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Tue, 27 Aug 2024 20:51:14 +0100 Subject: [PATCH 7/8] Update content/md/en/docs/polkadot-sdk/index.md Co-authored-by: bader y --- content/md/en/docs/polkadot-sdk/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/md/en/docs/polkadot-sdk/index.md b/content/md/en/docs/polkadot-sdk/index.md index 813d2ff58..f4ce040f6 100644 --- a/content/md/en/docs/polkadot-sdk/index.md +++ b/content/md/en/docs/polkadot-sdk/index.md @@ -26,7 +26,7 @@ new home. Consider the [resources below](#alternative-resources) as primary sour > You may still access the old content of this website in the navbar, but be aware of the fact that some content might not be up to date. -Note that **this does not impact the development of Substrate as a framework**. Substrate, as a framework, is still being maintained with full steam as a part of polkadot-sdk, and retains its full ability to be used to build both [standalone blockchains](https://github.com/paritytech/polkadot-sdk-solochain-template), or [Polkadot powered parachains](https://github.com/paritytech/polkadot-sdk-parachain-template). +Note that **this does not impact the development of Substrate as a framework**. Substrate, as a framework, is still being maintained with full steam as a part of `polkadot-sdk`, and retains its full ability to be used to build both [standalone blockchains](https://github.com/paritytech/polkadot-sdk-solochain-template), or [Polkadot powered parachains](https://github.com/paritytech/polkadot-sdk-parachain-template). ## Alternative Resources From de98b7f0532a407a385ab6c48cd9bbeea40b50da Mon Sep 17 00:00:00 2001 From: kianenigma Date: Wed, 28 Aug 2024 16:28:09 +0100 Subject: [PATCH 8/8] remove deprecated word --- content/config/nav.yaml | 20 ++++++++++---------- content/md/en/docs/polkadot-sdk/index.md | 2 +- src/templates/single.js | 3 ++- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/content/config/nav.yaml b/content/config/nav.yaml index 9cd4998a4..27dfe9277 100644 --- a/content/config/nav.yaml +++ b/content/config/nav.yaml @@ -16,7 +16,7 @@ polkadot-sdk: url: /polkadot-sdk/ quick-start: - title: Quick start (Deprecated) + title: Quick start url: /quick-start/ pages: - title: Substrate at a glance @@ -29,7 +29,7 @@ quick-start: url: /quick-start/modify-the-runtime/ learn: - title: Learn (Deprecated) + title: Learn url: /learn/ pages: - title: Welcome to Substrate @@ -74,7 +74,7 @@ learn: url: /learn/xcm-communication/ install: - title: Install (Deprecated) + title: Install url: /install/ pages: - title: Rust toolchain @@ -111,7 +111,7 @@ install: #- title: Economic models #url: /design/economic-models/ build: - title: Build (Deprecated) + title: Build url: /build/ pages: - title: Smart contracts @@ -148,7 +148,7 @@ build: #url: /build/executor/ test: - title: Test (Deprecated) + title: Test url: /test/ pages: - title: Unit test @@ -163,7 +163,7 @@ test: url: /test/check-runtime/ deploy: - title: Deploy (Deprecated) + title: Deploy url: /deploy/ pages: - title: Prepare to deploy @@ -179,7 +179,7 @@ deploy: # - title: Launch a parachain # url: /deploy/launch-a-parachain/ maintain: - title: Maintain (Deprecated) + title: Maintain url: /maintain/ pages: - title: Monitor @@ -196,7 +196,7 @@ maintain: # url: /maintain/data-migration/ tutorials: - title: Tutorials (Deprecated) + title: Tutorials url: /tutorials/ pages: - title: Build a blockchain @@ -287,7 +287,7 @@ tutorials: # url: /tutorials/integrate-with-tools/access-evm-accounts/ reference: - title: Reference (Deprecated) + title: Reference url: /reference/ pages: - title: Rust API @@ -340,7 +340,7 @@ reference: url: /reference/how-to-guides/ community: - title: Community (Deprecated) + title: Community url: /community/ pages: - title: Content style guide diff --git a/content/md/en/docs/polkadot-sdk/index.md b/content/md/en/docs/polkadot-sdk/index.md index df2e4949d..3a2e210e2 100644 --- a/content/md/en/docs/polkadot-sdk/index.md +++ b/content/md/en/docs/polkadot-sdk/index.md @@ -35,5 +35,5 @@ Below, you can find a number of replacement resources to learn more about Polkad - [Polkadot Wiki](https://wiki.polkadot.network/docs/build-guide) - [Polkadot Developers](https://github.com/polkadot-developers/) - [Polkadot Blockchain Academy](https://polkadot.com/blockchain-academy) -- Polkadot Ecosystem Documentation by Papermoon (Work in progress) - [Polkadot SDK Rust Docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html) +- Polkadot Ecosystem Documentation by Papermoon (Work in progress, see progress [here](https://forum.polkadot.network/t/decentralized-futures-papermoon-first-updates/9265)) diff --git a/src/templates/single.js b/src/templates/single.js index 1d999e8e2..658150963 100644 --- a/src/templates/single.js +++ b/src/templates/single.js @@ -107,12 +107,13 @@ export default function DocsSinglePage({ data, pageContext }) {
{location.pathname !== '/polkadot-sdk' && (
- ⚠️ Deprecation Notice: + ⚠️ Update Notice:

Please read Substrate to Polkadot SDK page first.

+
)}