Skip to content

Commit cac50a6

Browse files
authored
add lock and improve readme (#2177)
* add lock and improve readme * Update gatsby-plugin-substrate * fixes to 404 links
1 parent 96f0f17 commit cac50a6

File tree

10 files changed

+14674
-26
lines changed

10 files changed

+14674
-26
lines changed

.netlify/_redirects

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
/newsletter https://substrate.io/ecosystem/connect/newsletter/ 301!
3232
/seminar https://substrate.io/ecosystem/resources/seminar/ 301!
3333
/terms https://www.parity.io/terms/ 301!
34-
/awesome-substrate https://github.com/substrate-developer-hub/awesome-substrate/blob/master/README.md 301!
34+
/awesome-substrate https://github.com/polkadot-developers/awesome-substrate/blob/master/README.md 301!
3535

3636
/vundefined / 301!
3737
/vundefined/* / 301!

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h1 align="center">
22
<a href="https://www.docs.substrate.io">
3-
<img alt="Substrate Logo" src="https://github.com/substrate-developer-hub/substrate-docs/raw/main/static/img/sub.gif" width="70%" />
3+
<img alt="Substrate Logo" src="https://github.com/polkadot-developers/substrate-docs/raw/main/static/img/sub.gif" width="70%" />
44
</a>
55
</h1>
66
<h1 align="center">Substrate Docs</h1>
@@ -74,10 +74,24 @@ yarn
7474

7575
This website uses a submodule for shared components. To set it up please refer to the [gatsby-plugin-substrate repository](https://github.com/paritytech/gatsby-plugin-substrate#troubleshooting).
7676

77+
```shell
78+
git submodule update --init --recursive
79+
```
80+
81+
To update the submodule to the latest main branch, run:
82+
83+
```shell
84+
git submodule update --remote
85+
```
86+
7787
**Configure environment variables**
7888

7989
Copy `example.env.development` into a new `.env.development` file.
8090

91+
```shell
92+
cp example.env.development .env.development
93+
```
94+
8195
Config URL variables based on your preferable local setup.
8296
URL will be used for links generation between Substrate websites.
8397

config/menus.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ const resources = [
136136
id: 'ecosystem.resources.past-seminars',
137137
},
138138
{
139-
url: 'https://github.com/substrate-developer-hub/awesome-substrate/blob/master/README.md',
139+
url: 'https://github.com/spolkadot-developers/awesome-substrate/blob/master/README.md',
140140
id: 'ecosystem.resources.awesome-substrate',
141141
},
142142
];

config/siteMetadata.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ module.exports = {
2121
gitter: 'https://gitter.im/paritytech/parity',
2222
stackoverflow: 'https://stackoverflow.com/questions/tagged/substrate',
2323
stackexchange: 'https://substrate.stackexchange.com',
24-
githubDevhub: 'https://github.com/substrate-developer-hub/',
24+
githubDevhub: 'https://github.com/polkadot-developers/',
2525
};

content/md/en/docs/install/linux.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -141,17 +141,13 @@ To compile the Substrate node template:
141141
1. Clone the node template repository by running the following command:
142142

143143
```bash
144-
git clone https://github.com/substrate-developer-hub/substrate-node-template
144+
git clone https://github.com/paritytech/polkadot-sdk-minimal-template
145145
```
146146

147-
In most cases, you can clone the `main` branch to get the latest code.
148-
However, you can use the `--branch` command-line option if you want to work with a Substrate branch that is compatible with a specific Polkadot version.
149-
Click [Tags](https://github.com/substrate-developer-hub/substrate-node-template/tags) to see the list of branches that are compatible with specific Polkadot versions.
150-
151147
1. Change to the root of the node template directory by running the following command:
152148

153149
```bash
154-
cd substrate-node-template
150+
cd polkadot-sdk-minimal-template
155151
```
156152

157153
If you want to save your changes and make this branch easy to identify, you can create a new branch by running a command similar to the following:
@@ -160,21 +156,15 @@ To compile the Substrate node template:
160156
git switch -c my-wip-branch
161157
```
162158

163-
1. Compile the node template by running the following command:
164-
165-
```bash
166-
cargo build --release
167-
```
168-
169-
Because of the number of packages required, compiling the node can take several minutes.
159+
Follow the instructions in the README.md file to build the node.
170160

171161
After the build completes successfully, your local computer is ready for Substrate development activity.
172162

173163
## Where to go next
174164

175165
The Substrate Developer Hub acts as a central portal for access to the many resources available to the community.
176166
Depending on your interests and learning style, you might prefer one avenue over another.
177-
For example, if you prefer to read source code and are familiar with Rust, you might want to start by digging into the [Rust API](https://paritytech.github.io/substrate/master).
167+
For example, if you prefer to read source code and are familiar with Rust, you might want to start by digging into the [Rust API](https://paritytech.github.io/polkadot-sdk/master).
178168

179169
#### Tell me
180170

content/md/en/docs/reference/how-to-guides/parachains/convert-a-solo-chain.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ However, there are a few important differences between the node and parachain te
3535

3636
### Parachain info pallet
3737

38-
By default, the parachain template [runtime](https://github.com/substrate-developer-hub/substrate-parachain-template/blob/main/runtime/Cargo.toml) includes several parachain-specific pallets, including a [`parachain-info` pallet](https://paritytech.github.io/cumulus/parachain_info/pallet/index.html).
38+
By default, the parachain template [runtime](https://github.com/paritytech/polkadot-sdk-parachain-template/blob/master/runtime/Cargo.toml) includes several parachain-specific pallets, including a [`parachain-info` pallet](https://paritytech.github.io/polkadot-sdk/master/staging_parachain_info/pallet/index.html).
3939
This pallet is designed to inject the unique parachain identifier into the parachain runtime.
4040
This information allows the runtime to know which cross-chain messages are intended for it.
4141

@@ -61,7 +61,7 @@ In contrast, the Substrate node template and many other Substrate-based chains i
6161

6262
### Collator service
6363

64-
The collator service—[`node/src/service.rs`](https://github.com/substrate-developer-hub/substrate-parachain-template/blob/main/node/src/service.rs)—is entirely different in the parachain template from the similarly-named [`node/src/service.rs`](https://github.com/substrate-developer-hub/substrate-node-template/blob/main/node/src/service.rs) in the node template.
64+
The collator service—[`node/src/service.rs`](https://github.com/paritytech/polkadot-sdk-parachain-template/blob/master/node/src/service.rs)—is entirely different in the parachain template from the similarly-named [`node/src/service.rs`](https://github.com/paritytech/polkadot-sdk-parachain-template/blob/master/node/src/service.rs) in the node template.
6565
The collator service is explicitly designed as a wrapper to provide parachain-specific operations that a standard Substrate node doesn't require.
6666

67-
If you have an existing Substrate chain that you want to convert to a parachain, you should copy the [`node/src/service.rs`](https://github.com/substrate-developer-hub/substrate-parachain-template/blob/main/node/src/service.rs) from the parachain template as a starting point.
67+
If you have an existing Substrate chain that you want to convert to a parachain, you should copy the [`node/src/service.rs`](https://github.com/paritytech/polkadot-sdk-parachain-template/blob/master/node/src/service.rs) from the parachain template as a starting point.

content/md/en/docs/reference/how-to-guides/parachains/prepare-to-launch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You want to isolate them to a distinct peer group with this ID.
2727
Protocol ID collisions will cause _many_ issues for your nodes.
2828

2929
In order to set a unique protocol ID, change make sure you use some nonce or salt value. This is set
30-
(for the [parachain node template](https://github.com/substrate-developer-hub/substrate-parachain-template/))
30+
(for the [parachain node template](https://github.com/paritytech/polkadot-sdk-parachain-template/))
3131
as a CLI item in `/client/network/src/command.rs`, and passed to extend the `/client/network/src/chain_spec.rs`
3232

3333
All [chain specification](/build/chain-spec/) files include this item as a field.
@@ -66,7 +66,7 @@ the amount of resource consumption as much as possible for the relay chain.
6666

6767
## Critical parachain constraints
6868

69-
You can check the maximum sizes [in the Polkadot repo](https://github.com/paritytech/polkadot/blob/f0e1ed0bab6d5cb542b84fa0ad464609198dd255/primitives/src/v2/mod.rs#L322-L348) for all relay chains (these are common constants).
69+
You can check the maximum sizes [in the Polkadot repo](https://github.com/paritytech/polkadot-sdk/blob/43cd6fd4370d3043272f64a79aeb9e6dc0edd13f/polkadot/primitives/src/v8/mod.rs#L401-L429) for all relay chains (these are common constants).
7070
Make note of:
7171

7272
- The runtime version of the relay chain you are targeting (these _may_ change)

example.env.development

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# GATSBY_WEBSITE_URL=http://localhost:8100
2-
# GATSBY_DOCS_URL=http://localhost:8200
1+
GATSBY_WEBSITE_URL=http://localhost:8100
2+
GATSBY_DOCS_URL=http://localhost:8200

0 commit comments

Comments
 (0)