Skip to content

Commit 2e8fa6d

Browse files
committed
bold steps towards deprecation
1 parent 1c9dc87 commit 2e8fa6d

File tree

10 files changed

+276
-45
lines changed

10 files changed

+276
-45
lines changed

.netlify/_redirects

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Redirects from what the browser requests to what we serve
22

3-
/rustdocs https://paritytech.github.io/substrate/master/sc_service/ 301!
3+
/rustdocs https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html 301!
44

55
/how-to-guides /reference/ 301!
66

content/config/nav.yaml

+17-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
menu:
2+
- polkadot-sdk
23
- quick-start
34
- learn
45
- install
@@ -10,8 +11,12 @@ menu:
1011
- reference
1112
- community
1213

14+
polkadot-sdk:
15+
title: Substrate -> Polkadot SDK
16+
url: /polkadot-sdk/
17+
1318
quick-start:
14-
title: Quick start
19+
title: Quick start (Deprecated)
1520
url: /quick-start/
1621
pages:
1722
- title: Substrate at a glance
@@ -24,7 +29,7 @@ quick-start:
2429
url: /quick-start/modify-the-runtime/
2530

2631
learn:
27-
title: Learn
32+
title: Learn (Deprecated)
2833
url: /learn/
2934
pages:
3035
- title: Welcome to Substrate
@@ -69,7 +74,7 @@ learn:
6974
url: /learn/xcm-communication/
7075

7176
install:
72-
title: Install
77+
title: Install (Deprecated)
7378
url: /install/
7479
pages:
7580
- title: Rust toolchain
@@ -84,7 +89,7 @@ install:
8489
url: /install/developer-tools/
8590
- title: Troubleshoot Rust issues
8691
url: /install/troubleshoot-rust-issues/
87-
92+
8893
#design:
8994
# title: Design
9095
# url: /design/
@@ -106,7 +111,7 @@ install:
106111
#- title: Economic models
107112
#url: /design/economic-models/
108113
build:
109-
title: Build
114+
title: Build (Deprecated)
110115
url: /build/
111116
pages:
112117
- title: Smart contracts
@@ -143,7 +148,7 @@ build:
143148
#url: /build/executor/
144149

145150
test:
146-
title: Test
151+
title: Test (Deprecated)
147152
url: /test/
148153
pages:
149154
- title: Unit test
@@ -156,9 +161,9 @@ test:
156161
url: /test/simulate-parachains/
157162
- title: Check runtime
158163
url: /test/check-runtime/
159-
164+
160165
deploy:
161-
title: Deploy
166+
title: Deploy (Deprecated)
162167
url: /deploy/
163168
pages:
164169
- title: Prepare to deploy
@@ -174,7 +179,7 @@ deploy:
174179
# - title: Launch a parachain
175180
# url: /deploy/launch-a-parachain/
176181
maintain:
177-
title: Maintain
182+
title: Maintain (Deprecated)
178183
url: /maintain/
179184
pages:
180185
- title: Monitor
@@ -191,7 +196,7 @@ maintain:
191196
# url: /maintain/data-migration/
192197

193198
tutorials:
194-
title: Tutorials
199+
title: Tutorials (Deprecated)
195200
url: /tutorials/
196201
pages:
197202
- title: Build a blockchain
@@ -282,7 +287,7 @@ tutorials:
282287
# url: /tutorials/integrate-with-tools/access-evm-accounts/
283288

284289
reference:
285-
title: Reference
290+
title: Reference (Deprecated)
286291
url: /reference/
287292
pages:
288293
- title: Rust API
@@ -335,7 +340,7 @@ reference:
335340
url: /reference/how-to-guides/
336341

337342
community:
338-
title: Community
343+
title: Community (Deprecated)
339344
url: /community/
340345
pages:
341346
- title: Content style guide

content/md/en/docs/examples/quickstart/index.html

+9-9
Original file line numberDiff line numberDiff line change
@@ -20,36 +20,36 @@
2020
}
2121
</style>
2222
</head>
23-
23+
2424
<body>
2525
<main role="main" class="container">
2626
<h1 style="font-family: sans-serif; font-weight: 500;">Display an account balance</h1>
2727
<p style="font-family: sans-serif;">Enter a development account address, then click <b>Get Balance</b>.</p>
28-
28+
2929
<input type="text" size="58" id="account_address"/>
3030
<input type="button" onclick="GetBalance()" value="Get Balance">
3131
<p class="output">Balance: <span id="polkadot-balance">Not Connected</span></p>
3232
</main>
33-
33+
3434
<script src="https://unpkg.com/@polkadot/util/bundle-polkadot-util.js"></script>
3535
<script src="https://unpkg.com/@polkadot/util-crypto/bundle-polkadot-util-crypto.js"></script>
3636
<script src="https://unpkg.com/@polkadot/types/bundle-polkadot-types.js"></script>
3737
<script src="https://unpkg.com/@polkadot/api/bundle-polkadot-api.js"></script>
38-
38+
3939
<script>
4040
async function GetBalance() {
4141
const ADDR = '5Gb6Zfe8K8NSKrkFLCgqs8LUdk7wKweXM5pN296jVqDpdziR';
42-
42+
4343
const { WsProvider, ApiPromise } = polkadotApi;
4444
const wsProvider = new WsProvider('ws://127.0.0.1:9944');
4545
const polkadot = await ApiPromise.create({ provider: wsProvider });
46-
46+
4747
let polkadotBalance = document.getElementById("polkadot-balance");
4848
const x = document.getElementById("account_address").value;
4949
const { data: balance } = await polkadot.query.system.account(x);
50-
50+
5151
polkadotBalance.innerText = balance.free;
52-
}
52+
}
5353
</script>
5454
</body>
55-
</html>
55+
</html>
+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Polkadot SDK
3+
description:
4+
keywords:
5+
- polkadot-sdk
6+
---
7+
8+
9+
## Substrate to Polkadot SDK
10+
11+
In [May
12+
2023](https://forum.polkadot.network/t/psa-parity-is-currently-working-on-merging-the-polkadot-stack-repositories-into-one-single-repository/2883),
13+
Parity Technologies started moving 3 repositories of
14+
[`substrate`](https://github.com/paritytech/substrate),
15+
[`polkadot`](https://github.com/paritytech/polkadot), and
16+
[`cumulus`](https://github.com/paritytech/cumulus), formerly independent in development and
17+
branding, under one mew mono-repo called
18+
[`polkadot-sdk`](https://github.com/paritytech/polkadot-sdk). Consequently, the [runtimes of the
19+
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/).
20+
21+
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.
22+
23+
Most impacted in this transition is **Substrate**, and part of this impact is gradual deprecation of
24+
this website. The content in this website is no longer maintained, and will be gradually moved to a
25+
new home. Consider the following resources as primary sources of information.
26+
27+
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).
28+
29+
## Alternative Resources
30+
31+
Below, you can find a number of replacement resources to learn more about Polkadot SDK:
32+
33+
- [Polkadot Wiki](https://wiki.polkadot.network/)
34+
- [Polkadot Developers](https://github.com/polkadot-developers/)
35+
- [Polkadot Blockchain Academy](https://academy.polkadot.network/)
36+
- [Polkadot Ecosystem Documentation by Papermoon](https://wiki.polkadot.network/)
37+
- [Polkadot SDK Rust Docs](https://wiki.polkadot.network/)

content/md/en/homepage/get-started-homepage.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ bodyLinkTwoTitle: Blockchain basics
1010
bodyLinkTwoURL: /learn/blockchain-basics/
1111
bodyLinkThreeTitle: Architecture and Rust libraries
1212
bodyLinkThreeURL: /learn/architecture/
13+
bodyLinkFourTitle:
14+
bodyLinkFourURL:
1315
---

content/md/en/homepage/get-technical-homepage.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ bodyLinkTwoTitle: Rust for Substrate
1010
bodyLinkTwoURL: /learn/rust-basics/
1111
bodyLinkThreeTitle: Command-line tools
1212
bodyLinkThreeURL: /reference/command-line-tools/
13+
bodyLinkFourTitle:
14+
bodyLinkFourURL:
1315
---

content/md/en/homepage/hands-on-homepage.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ bodyLinkTwoTitle: Simulate a network
1010
bodyLinkTwoURL: /tutorials/build-a-blockchain/simulate-network/
1111
bodyLinkThreeTitle: Add a pallet
1212
bodyLinkThreeURL: /tutorials/build-application-logic/add-a-pallet/
13+
bodyLinkFourTitle:
14+
bodyLinkFourURL:
1315
---

src/pages/index.js

+52-13
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,45 @@ import { graphql } from 'gatsby';
22
import { Layout, Section, SEO } from 'gatsby-plugin-substrate';
33
import React from 'react';
44

5-
import CardsList from '../components/layout/Documentation/CardList';
6-
import SearchDocumentation from '../components/ui/SearchDocumentation';
5+
import Card from '../components/layout/Documentation/Card';
6+
// import CardsList from '../components/layout/Documentation/CardList';
7+
// import SearchDocumentation from '../components/ui/SearchDocumentation';
78

89
export default function Home({ data }) {
9-
const { content } = data;
10+
// eslint-disable-next-line no-empty-pattern
11+
const {} = data;
1012
return (
1113
<Layout showFooterNewsletter={false} mode="full">
1214
<SEO title="Home" />
13-
<Section className="text-center mt-12">
14-
<h1 className="mb-8 text-4xl lg:text-6xl md:text-6xl font-title font-extrabold">Substrate Documentation</h1>
15-
<div className="sm:max-w-lg mx-auto mb-10">
16-
<p className="max-w-lg text-xl mx-auto">
17-
Substrate documentation includes conceptual, procedural, and reference information for blockchain builders
18-
and parachain project teams.
19-
</p>
20-
</div>
21-
<SearchDocumentation />
15+
<Section className="text-center mt-12 intro">
16+
<h1 className="mb-8 text-4xl lg:text-6xl md:text-6xl font-title font-extrabold substrate">Substrate</h1>
17+
<p>Is now part of </p>
18+
<h1
19+
className="
20+
mb-8 text-4xl
21+
lg:text-6xl
22+
md:text-6xl
23+
font-title
24+
font-extrabold
25+
polkadot-sdk
26+
underline-effect"
27+
>
28+
Polkadot SDK
29+
</h1>
2230
</Section>
2331
<Section className="flex justify-center">
24-
<CardsList data={content.edges} />
32+
<Card
33+
title="Polkadot SDK"
34+
text="Polkadot SDK is now the overarching name for Substrate, and the rest of Polkadot's Development Kit"
35+
featured_image="/media/images/homepage/hands-on.png"
36+
link="/polkadot-sdk"
37+
bodyLinkOneURL="https://github.com/polkadot-developers/"
38+
bodyLinkOneTitle="Polkadot Developers"
39+
bodyLinkTwoURL="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html"
40+
bodyLinkTwoTitle="Polkadot SDK Docs"
41+
bodyLinkThreeURL="https://papermoonio.github.io/polkadot-ecosystem-docs-draft/"
42+
bodyLinkThreeTitle="Polkadot Ecosystem Documentation"
43+
/>
2544
</Section>
2645
</Layout>
2746
);
@@ -38,6 +57,26 @@ export const query = graphql`
3857
}
3958
}
4059
}
60+
goodbye: allMarkdownRemark(filter: { fileAbsolutePath: { regex: "/homepage/goodbye.md$/" } }) {
61+
edges {
62+
node {
63+
id
64+
frontmatter {
65+
title
66+
link
67+
order
68+
description
69+
bodyLinkOneURL
70+
bodyLinkOneTitle
71+
bodyLinkTwoURL
72+
bodyLinkTwoTitle
73+
bodyLinkThreeURL
74+
bodyLinkThreeTitle
75+
featured_image
76+
}
77+
}
78+
}
79+
}
4180
content: allMarkdownRemark(filter: { fileAbsolutePath: { regex: "//(homepage)/" } }) {
4281
edges {
4382
node {

0 commit comments

Comments
 (0)