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

Use correct target dir in polkadot readme #1643

Merged
merged 4 commits into from
Sep 22, 2023

Conversation

skunert
Copy link
Contributor

@skunert skunert commented Sep 20, 2023

Closes #1372

This fixes the target directories in the polkadot readme. I verified manually the Ubuntu based install works on a fresh cloud machine. Build from source also worked as described.

Since #1304 landed --dev also works again (not on v1.1.0 though), so I would consider the install instructions fixed.

@skunert skunert added R0-silent Changes should not be mentioned in any release notes T8-polkadot This PR/Issue is related to/affects the Polkadot network. labels Sep 20, 2023
@skunert skunert requested review from ggwpez and a team September 20, 2023 10:44
Copy link
Member

@ggwpez ggwpez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for looking into this. Maybe @wentelteefje or someone from the @paritytech/docs-audit can jump in as well.

polkadot/README.md Show resolved Hide resolved
polkadot/README.md Show resolved Hide resolved
polkadot/README.md Show resolved Hide resolved
polkadot/README.md Show resolved Hide resolved
polkadot/README.md Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

curl https://getsubstrate.io -sSf | bash -s -- --fast

DQ but do you know where / how this is maintained? It mentions the old Substrate repo in the code.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no idea. In the substrate README we are linking to https://docs.substrate.io/install/, which is probably a good idea here too, since the build environment and requirements for polkadot should not be different from what is described there. This getsubstrate stuff can be removed then.

polkadot/README.md Show resolved Hide resolved
@skunert
Copy link
Contributor Author

skunert commented Sep 20, 2023

I updated the readme and removed a lot of outdated stuff.

  • That we separated polkadot and substrate in 2018 (ancient history by tech standards)
  • init.sh and links to outdated getsubstrate.io removed
  • Build-environment instructions removed, since the build env is the same as for substrate, I linked to the substrate docs. The readme assumes users prepare their env and focuses on the polkadot-repo specific things

Copy link
Member

@ggwpez ggwpez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think this cleanup was much needed.

@skunert skunert enabled auto-merge (squash) September 22, 2023 09:36
@skunert skunert merged commit fb0fd3e into paritytech:master Sep 22, 2023
107 of 109 checks passed
@kureus
Copy link

kureus commented Oct 17, 2023

What's the rationale behind deleting polkadot/scripts/init.sh, this would appear to be intentional? However it's still referenced in the Build from source section in the readme and in the wiki

@ggwpez
Copy link
Member

ggwpez commented Oct 17, 2023

What's the rationale behind deleting polkadot/scripts/init.sh, this would appear to be intentional? However it's still referenced in the Build from source section in the readme and in the wiki

Its not needed anymore. Standard rust stable should be enough. But yea, the other places should be fixed.
cc @Rashmirreddy

bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this pull request Mar 25, 2024
Closes paritytech#1372 

This fixes the target directories in the polkadot readme. I verified
manually the Ubuntu based install works on a fresh cloud machine. Build
from source also worked as described.

Since paritytech#1304 landed `--dev` also works again (not on v1.1.0 though), so I
would consider the install instructions fixed.
serban300 pushed a commit to serban300/polkadot-sdk that referenced this pull request Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
R0-silent Changes should not be mentioned in any release notes T8-polkadot This PR/Issue is related to/affects the Polkadot network.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Polkadot install instructions do not work
8 participants