Skip to content

Commit

Permalink
Meta Depreaction (#2172)
Browse files Browse the repository at this point in the history
* bold steps towards deprecation

* update

* remoe unused

* Apply suggestions from code review

Co-authored-by: Radha <86818441+DrW3RK@users.noreply.github.com>

* nits

* Update content/md/en/docs/polkadot-sdk/index.md

Co-authored-by: bader y <ibnbassem@gmail.com>

* Update content/md/en/docs/polkadot-sdk/index.md

Co-authored-by: bader y <ibnbassem@gmail.com>

* remove deprecated word

---------

Co-authored-by: Radha <86818441+DrW3RK@users.noreply.github.com>
Co-authored-by: bader y <ibnbassem@gmail.com>
  • Loading branch information
3 people authored Aug 28, 2024
1 parent c75cc23 commit d40fcba
Show file tree
Hide file tree
Showing 26 changed files with 288 additions and 111 deletions.
2 changes: 1 addition & 1 deletion .netlify/_redirects
Original file line number Diff line number Diff line change
@@ -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!

Expand Down
9 changes: 7 additions & 2 deletions content/config/nav.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
menu:
- polkadot-sdk
- quick-start
- learn
- install
Expand All @@ -10,6 +11,10 @@ menu:
- reference
- community

polkadot-sdk:
title: Substrate to Polkadot SDK
url: /polkadot-sdk/

quick-start:
title: Quick start
url: /quick-start/
Expand Down Expand Up @@ -84,7 +89,7 @@ install:
url: /install/developer-tools/
- title: Troubleshoot Rust issues
url: /install/troubleshoot-rust-issues/

#design:
# title: Design
# url: /design/
Expand Down Expand Up @@ -156,7 +161,7 @@ test:
url: /test/simulate-parachains/
- title: Check runtime
url: /test/check-runtime/

deploy:
title: Deploy
url: /deploy/
Expand Down
21 changes: 13 additions & 8 deletions content/md/en/docs/build/genesis-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords:
---

<div class="warning">
<strong>⚠️ WARNING:</strong> This page contains outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/frame_support/pallet_macros/attr.genesis_build.html">Rust docs</a> for the most up-to-date documentation on this topic.
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/frame_support/pallet_macros/attr.genesis_build.html">Rust docs</a> for the most up-to-date documentation on this topic.
</div>


Expand All @@ -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:
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion content/md/en/docs/build/origins.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ keywords:
---

<div class="warning">
<strong>⚠️ WARNING:</strong> This page contains outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_origin/index.html">Rust docs</a> for the most up-to-date documentation on this topic.
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_origin/index.html">Rust docs</a> for the most up-to-date documentation on this topic.
</div>

The runtime origin is used by dispatchable functions to check where a call has come from.
Expand Down
7 changes: 1 addition & 6 deletions content/md/en/docs/build/pallet-coupling.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_pallet_coupling/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_pallet_coupling/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

The term **coupling** is often used to describe the degree to which two software modules depend on each other.
Expand Down
2 changes: 1 addition & 1 deletion content/md/en/docs/build/remote-procedure-calls.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords:
---

<div class="warning">
<strong>⚠️ WARNING:</strong> This page may contain outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/custom_runtime_api_rpc/index.html">Rust docs</a> for the most up-to-date documentation on this topic.
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/custom_runtime_api_rpc/index.html">Rust docs</a> for the most up-to-date documentation on this topic.
</div>

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.
Expand Down
18 changes: 9 additions & 9 deletions content/md/en/docs/examples/quickstart/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,36 +20,36 @@
}
</style>
</head>

<body>
<main role="main" class="container">
<h1 style="font-family: sans-serif; font-weight: 500;">Display an account balance</h1>
<p style="font-family: sans-serif;">Enter a development account address, then click <b>Get Balance</b>.</p>

<input type="text" size="58" id="account_address"/>
<input type="button" onclick="GetBalance()" value="Get Balance">
<p class="output">Balance: <span id="polkadot-balance">Not Connected</span></p>
</main>

<script src="https://unpkg.com/@polkadot/util/bundle-polkadot-util.js"></script>
<script src="https://unpkg.com/@polkadot/util-crypto/bundle-polkadot-util-crypto.js"></script>
<script src="https://unpkg.com/@polkadot/types/bundle-polkadot-types.js"></script>
<script src="https://unpkg.com/@polkadot/api/bundle-polkadot-api.js"></script>

<script>
async function GetBalance() {
const ADDR = '5Gb6Zfe8K8NSKrkFLCgqs8LUdk7wKweXM5pN296jVqDpdziR';

const { WsProvider, ApiPromise } = polkadotApi;
const wsProvider = new WsProvider('ws://127.0.0.1:9944');
const polkadot = await ApiPromise.create({ provider: wsProvider });

let polkadotBalance = document.getElementById("polkadot-balance");
const x = document.getElementById("account_address").value;
const { data: balance } = await polkadot.query.system.account(x);

polkadotBalance.innerText = balance.free;
}
}
</script>
</body>
</html>
</html>
7 changes: 1 addition & 6 deletions content/md/en/docs/learn/offchain-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

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.
Expand Down
39 changes: 39 additions & 0 deletions content/md/en/docs/polkadot-sdk/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
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 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
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 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 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 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.
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/docs/build-guide)
- [Polkadot Developers](https://github.com/polkadot-developers/)
- [Polkadot Blockchain Academy](https://polkadot.com/blockchain-academy)
- [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))
2 changes: 1 addition & 1 deletion content/md/en/docs/reference/frame-macros.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description:
keywords:
---
<div class="warning">
<strong>⚠️ WARNING:</strong> This section contains outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/frame_support/attr.pallet.html">Rust docs</a> for the most up-to-date documentation on this topic.
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/frame_support/attr.pallet.html">Rust docs</a> for the most up-to-date documentation on this topic.
</div>

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

The _How-to_ guides in the _Offchain workers_ category illustrate common use cases for offchain operations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

This guide will step you through how to pass data from an extrinsic to an offchain worker without writing to storage.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

This guide will teach you how to use an offchain worker to save retrieved data in local storage for future access.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_pallet_coupling/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_pallet_coupling/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

This guide demonstrates how to reuse a function or type from one pallet in another pallet using a technique called **loose coupling**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_pallet_coupling/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_pallet_coupling/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

Tight coupling two pallets is a technique to write pallets that re-use types and methods from an existing pallet.
Expand Down
7 changes: 1 addition & 6 deletions content/md/en/docs/reference/xcm-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/xcm/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/xcm/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

This section provides reference information for the cross-consensus message (XCM) format.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/substrate-api-sidecar/dist/">Sidecar docs</a>, the <a href="https://github.com/paritytech/substrate-api-sidecar?tab=readme-ov-file#note">README</a> and the <a href="https://github.com/paritytech/substrate-api-sidecar/tree/master/guides">guides folder</a> for the most up-to-date documentation on this topic.
</p>
</div>

The Substrate [sidecar](https://github.com/paritytech/substrate-api-sidecar) service provides a REST API for interacting with Substrate blockchain nodes built using FRAME.
Expand Down
2 changes: 2 additions & 0 deletions content/md/en/homepage/get-started-homepage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,6 @@ bodyLinkTwoTitle: Blockchain basics
bodyLinkTwoURL: /learn/blockchain-basics/
bodyLinkThreeTitle: Architecture and Rust libraries
bodyLinkThreeURL: /learn/architecture/
bodyLinkFourTitle:
bodyLinkFourURL:
---
2 changes: 2 additions & 0 deletions content/md/en/homepage/get-technical-homepage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,6 @@ bodyLinkTwoTitle: Rust for Substrate
bodyLinkTwoURL: /learn/rust-basics/
bodyLinkThreeTitle: Command-line tools
bodyLinkThreeURL: /reference/command-line-tools/
bodyLinkFourTitle:
bodyLinkFourURL:
---
2 changes: 2 additions & 0 deletions content/md/en/homepage/hands-on-homepage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
---
Loading

0 comments on commit d40fcba

Please sign in to comment.