Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Update Template README #12741

Merged
merged 8 commits into from
Feb 21, 2023
Merged

Update Template README #12741

merged 8 commits into from
Feb 21, 2023
+85 −134

Conversation

nuke-web3
Copy link
Contributor

  • remove matrix links
  • remove playground references (service reported as sun-setting)
  • OSPL rule per Docs style guide

@nuke-web3
update README
9a69055 
remove matrix links
remove playground references (service reported as sunsetting)
OSPL rule per Docs style guide
@nuke-web3 nuke-web3 added A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). I6-documentation Documentation needs fixing, improving or augmenting. B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit labels Nov 19, 2022
sacha-l
sacha-l reviewed Nov 23, 2022
View reviewed changes
Copy link
Contributor

@sacha-l sacha-l left a comment

Choose a reason for hiding this comment

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

Minor revision. Not sure about applying OSPL rule here because everything gets treated with cargo fmt anyways AFAIK.

bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
@nuke-web3
Copy link
Contributor Author

cargo doesn't have anything that touches .md files - so no it will not be formatted otherwise AFAIK

@nuke-web3
Copy link
Contributor Author

@sacha-l @lisa-parity @al3mart @jeluard - this should be ready now for review & merge, so we can act on https://github.com/substrate-developer-hub/substrate-node-template/issues/396

@nuke-web3 nuke-web3 mentioned this pull request Dec 12, 2022
Open
@bkchr bkchr mentioned this pull request Dec 12, 2022
Closed
lisa-parity
lisa-parity reviewed Dec 12, 2022
View reviewed changes
Copy link
Contributor

@lisa-parity lisa-parity left a comment

Choose a reason for hiding this comment

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

My suggestions

bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
bin/node-template/README.md Outdated Show resolved Hide resolved
@nuke-web3
Copy link
Contributor Author

Thank you very much @lisa-parity for the suggestions! 🤩 Merged them in now. I think we are OK to merge, please approve?

ltfschoen
ltfschoen reviewed Jan 1, 2023
View reviewed changes
bin/node-template/README.md

Then run the following command to start a single node development chain.

```bash
```sh
./scripts/docker_run.sh
Copy link
Contributor

@ltfschoen ltfschoen Jan 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

if i run clone the substrate repo, and check out this branch 'ds/template-readme', and then as root user i run ./bin/node-template/scripts/docker_run.sh it outputs -bash: ./bin/node-template/scripts/docker_run.sh: Permission denied. if i run
the following first chmod +x ./bin/node-template/scripts/docker_run.sh then i'm able to run that script.

if i then run git ls-tree -r HEAD, it outputs the following 100644 blob 0bac44b4cfb3b61959bc65ae6de72c22fade7ff4 bin/node-template/scripts/docker_run.sh.

so to change its permissions to 755 i think we should run chmod +x ./bin/node-template/scripts/docker_run.sh and then commit that change to this PR?

@ltfschoen ltfschoen mentioned this pull request Jan 1, 2023
Closed
4 tasks
@sacha-l
Copy link
Contributor

sacha-l commented Jan 16, 2023

Should work for you now (if you try again by undoing the chmod +x). Can you check @ltfschoen ? 🙏🏻

@ggwpez
Copy link
Member

ggwpez commented Jan 16, 2023

bot rebase

@paritytech-processbot
Copy link

Rebased

@nuke-web3
Copy link
Contributor Author

@sacha-l @jeluard - review and approve?

@ltfschoen  #13039 can come later, and thus is ok by you? Please approve

wyhaines
wyhaines approved these changes Feb 21, 2023
View reviewed changes
Copy link

@wyhaines wyhaines left a comment

Choose a reason for hiding this comment

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

I wanted to wait until I had time to actually read through all of this with focus. These changes improve the clarity and readability, to me, so FWIW, I approve of them.

@nuke-web3
Copy link
Contributor Author

bot merge

@paritytech-processbot
Copy link

Error: Statuses failed for 60038cc

@nuke-web3 nuke-web3 requested review from shawntabrizi and removed request for al3mart February 21, 2023 14:11
ggwpez
ggwpez approved these changes Feb 21, 2023
View reviewed changes
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.

Approving to unblock.

@nuke-web3
Copy link
Contributor Author

bot merge

@paritytech-processbot
Copy link

Error: Statuses failed for 60038cc

@nuke-web3
Copy link
Contributor Author

bot rebase

@paritytech-processbot
Copy link

Rebased

@ggwpez
Copy link
Member

ggwpez commented Feb 21, 2023

bot merge

@paritytech-processbot paritytech-processbot bot merged commit 59fd2ac into master Feb 21, 2023
@paritytech-processbot paritytech-processbot bot deleted the ds/template-readme branch February 21, 2023 22:24
ltfschoen pushed a commit to ltfschoen/substrate that referenced this pull request Feb 22, 2023
@nuke-web3 @lisa-parity @ltfschoen
Update Template README (paritytech#12741)
c4c7298 
* update README
remove matrix links
remove playground references (service reported as sunsetting)
OSPL rule per Docs style guide

* Apply suggestions from code review

Co-authored-by: Sacha Lansky <[email protected]>

* Update README.md

* Apply suggestions from code review

Co-authored-by: lisa-parity <[email protected]>

* (fix) chmod +x script

---------

Co-authored-by: Sacha Lansky <[email protected]>
Co-authored-by: lisa-parity <[email protected]>
Co-authored-by: parity-processbot <>
@ltfschoen ltfschoen mentioned this pull request Feb 22, 2023
Merged
4 tasks
ark0f pushed a commit to gear-tech/substrate that referenced this pull request Feb 27, 2023
@nuke-web3 @lisa-parity @ark0f
Update Template README (paritytech#12741)
0543845 
* update README
remove matrix links
remove playground references (service reported as sunsetting)
OSPL rule per Docs style guide

* Apply suggestions from code review

Co-authored-by: Sacha Lansky <[email protected]>

* Update README.md

* Apply suggestions from code review

Co-authored-by: lisa-parity <[email protected]>

* (fix) chmod +x script

---------

Co-authored-by: Sacha Lansky <[email protected]>
Co-authored-by: lisa-parity <[email protected]>
Co-authored-by: parity-processbot <>
Ank4n pushed a commit that referenced this pull request Feb 28, 2023
@nuke-web3 @lisa-parity @Ank4n
Update Template README (#12741)
3cc4705 
* update README
remove matrix links
remove playground references (service reported as sunsetting)
OSPL rule per Docs style guide

* Apply suggestions from code review

Co-authored-by: Sacha Lansky <[email protected]>

* Update README.md

* Apply suggestions from code review

Co-authored-by: lisa-parity <[email protected]>

* (fix) chmod +x script

---------

Co-authored-by: Sacha Lansky <[email protected]>
Co-authored-by: lisa-parity <[email protected]>
Co-authored-by: parity-processbot <>
@kiltbot kiltbot mentioned this pull request Apr 3, 2023
Closed
@librelois librelois mentioned this pull request Apr 6, 2023
Closed
ukint-vs pushed a commit to gear-tech/substrate that referenced this pull request Apr 10, 2023
@nuke-web3 @lisa-parity @ukint-vs
Update Template README (paritytech#12741)
45c3294 
* update README
remove matrix links
remove playground references (service reported as sunsetting)
OSPL rule per Docs style guide

* Apply suggestions from code review

Co-authored-by: Sacha Lansky <[email protected]>

* Update README.md

* Apply suggestions from code review

Co-authored-by: lisa-parity <[email protected]>

* (fix) chmod +x script

---------

Co-authored-by: Sacha Lansky <[email protected]>
Co-authored-by: lisa-parity <[email protected]>
Co-authored-by: parity-processbot <>
@kacperzuk-neti kacperzuk-neti mentioned this pull request Jun 23, 2023
Merged
15 tasks
nathanwhit pushed a commit to nathanwhit/substrate that referenced this pull request Jul 19, 2023
@nuke-web3 @lisa-parity @nathanwhit
Update Template README (paritytech#12741)
c79e623 
* update README
remove matrix links
remove playground references (service reported as sunsetting)
OSPL rule per Docs style guide

* Apply suggestions from code review

Co-authored-by: Sacha Lansky <[email protected]>

* Update README.md

* Apply suggestions from code review

Co-authored-by: lisa-parity <[email protected]>

* (fix) chmod +x script

---------

Co-authored-by: Sacha Lansky <[email protected]>
Co-authored-by: lisa-parity <[email protected]>
Co-authored-by: parity-processbot <>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ltfschoen ltfschoen ltfschoen left review comments

@wyhaines wyhaines wyhaines approved these changes

@jeluard jeluard jeluard approved these changes

@kianenigma kianenigma kianenigma approved these changes

@ggwpez ggwpez ggwpez approved these changes

@lisa-parity lisa-parity lisa-parity approved these changes

@sacha-l sacha-l Awaiting requested review from sacha-l

@shawntabrizi shawntabrizi Awaiting requested review from shawntabrizi

Assignees
No one assigned
Labels
A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit I6-documentation Documentation needs fixing, improving or augmenting.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@nuke-web3 @sacha-l @ggwpez @ltfschoen @wyhaines @jeluard @kianenigma @lisa-parity