Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Meta Depreaction #2172

Merged
merged 11 commits into from
Aug 28, 2024
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
29 changes: 17 additions & 12 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,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
Expand All @@ -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
Expand Down Expand Up @@ -69,7 +74,7 @@ learn:
url: /learn/xcm-communication/

install:
title: Install
title: Install (Deprecated)
url: /install/
pages:
- title: Rust toolchain
Expand All @@ -84,7 +89,7 @@ install:
url: /install/developer-tools/
- title: Troubleshoot Rust issues
url: /install/troubleshoot-rust-issues/

#design:
# title: Design
# url: /design/
Expand All @@ -106,7 +111,7 @@ install:
#- title: Economic models
#url: /design/economic-models/
build:
title: Build
title: Build (Deprecated)
url: /build/
pages:
- title: Smart contracts
Expand Down Expand Up @@ -143,7 +148,7 @@ build:
#url: /build/executor/

test:
title: Test
title: Test (Deprecated)
url: /test/
pages:
- title: Unit test
Expand All @@ -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
Expand All @@ -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
Expand All @@ -191,7 +196,7 @@ maintain:
# url: /maintain/data-migration/

tutorials:
title: Tutorials
title: Tutorials (Deprecated)
url: /tutorials/
pages:
- title: Build a blockchain
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -335,7 +340,7 @@ reference:
url: /reference/how-to-guides/

community:
title: Community
title: Community (Deprecated)
url: /community/
pages:
- title: Content style guide
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>
37 changes: 37 additions & 0 deletions content/md/en/docs/polkadot-sdk/index.md
Original file line number Diff line number Diff line change
@@ -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
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
[`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
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
[`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/).
kianenigma marked this conversation as resolved.
Show resolved Hide resolved

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.
kianenigma marked this conversation as resolved.
Show resolved Hide resolved

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).
kianenigma marked this conversation as resolved.
Show resolved Hide resolved

## Alternative Resources

Below, you can find a number of replacement resources to learn more about Polkadot SDK:

- [Polkadot Wiki](https://wiki.polkadot.network/)
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
- [Polkadot Developers](https://github.com/polkadot-developers/)
- [Polkadot Blockchain Academy](https://academy.polkadot.network/)
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
- [Polkadot Ecosystem Documentation by Papermoon](https://wiki.polkadot.network/)
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
- [Polkadot SDK Rust Docs](https://wiki.polkadot.network/)
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
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:
---
65 changes: 52 additions & 13 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
<Layout showFooterNewsletter={false} mode="full">
<SEO title="Home" />
<Section className="text-center mt-12">
<h1 className="mb-8 text-4xl lg:text-6xl md:text-6xl font-title font-extrabold">Substrate Documentation</h1>
<div className="sm:max-w-lg mx-auto mb-10">
<p className="max-w-lg text-xl mx-auto">
Substrate documentation includes conceptual, procedural, and reference information for blockchain builders
and parachain project teams.
</p>
</div>
<SearchDocumentation />
<Section className="text-center mt-12 intro">
<h1 className="mb-8 text-4xl lg:text-6xl md:text-6xl font-title font-extrabold substrate">Substrate</h1>
<p>Is now part of </p>
<h1
className="
mb-8 text-4xl
lg:text-6xl
md:text-6xl
font-title
font-extrabold
polkadot-sdk
underline-effect"
>
Polkadot SDK
</h1>
</Section>
<Section className="flex justify-center">
<CardsList data={content.edges} />
<Card
title="Polkadot SDK"
text="Polkadot SDK is now the overarching name for Substrate, and the rest of Polkadot's Development Kit"
featured_image="/media/images/homepage/hands-on.png"
link="/polkadot-sdk"
bodyLinkOneURL="https://github.com/polkadot-developers/"
bodyLinkOneTitle="Polkadot Developers"
bodyLinkTwoURL="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html"
bodyLinkTwoTitle="Polkadot SDK Docs"
bodyLinkThreeURL="https://papermoonio.github.io/polkadot-ecosystem-docs-draft/"
bodyLinkThreeTitle="Polkadot Ecosystem Documentation"
/>
</Section>
</Layout>
);
Expand All @@ -38,6 +57,26 @@ export const query = graphql`
}
}
}
goodbye: allMarkdownRemark(filter: { fileAbsolutePath: { regex: "/homepage/goodbye.md$/" } }) {
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
edges {
node {
id
frontmatter {
title
link
order
description
bodyLinkOneURL
bodyLinkOneTitle
bodyLinkTwoURL
bodyLinkTwoTitle
bodyLinkThreeURL
bodyLinkThreeTitle
featured_image
}
}
}
}
content: allMarkdownRemark(filter: { fileAbsolutePath: { regex: "//(homepage)/" } }) {
edges {
node {
Expand Down
Loading
Loading