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

Migrate to docs.substrate.io throughout #10007

Merged
merged 5 commits into from
Oct 13, 2021
Merged

Conversation

nuke-web3
Copy link
Contributor

@nuke-web3 nuke-web3 commented Oct 12, 2021

  • All crates homepage = "https://substrate.io" (this is almost all of the file changes)
    • It is unclear to me how this will affect crates.io and publishing there (if at all)
  • Fix all comments/doc links to use new site (a few were 404s previously)
    • Note: link to specific docs include v3 in the URL, for new versions of the docs we need to replace this manually (unless I am missing a redirect @imadarai @sacha-l ?)
  • Omits the template, this is in Move template to homepage = "https://substrate.io/" , correct links #10006

(#10017 created in this PR)

@github-actions github-actions bot added the A0-please_review Pull request needs code review. label Oct 12, 2021
@nuke-web3 nuke-web3 added 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. I6-documentation Documentation needs fixing, improving or augmenting. labels Oct 12, 2021
@nuke-web3 nuke-web3 self-assigned this Oct 12, 2021
@athei
Copy link
Member

athei commented Oct 12, 2021

Why not linking flat substrate.io there? Should be the better landing page when just wanting to learn what it is.

@bkchr
Copy link
Member

bkchr commented Oct 12, 2021

Why not linking flat substrate.io there? Should be the better landing page when just wanting to learn what it is.

Yeah. This field is named homepage, so it should link to substrate.io

Copy link
Contributor

@gilescope gilescope left a comment

Choose a reason for hiding this comment

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

LGTM - needs cargo fmt

@imadarai
Copy link

@nukemandan
Does this header gets applied to all the rust-docs or just substrate?

I'd like to remove Google Analytics and update the script with Simple Analytics (cookie-less), but will need the exact links where it's being used.

@nuke-web3
Copy link
Contributor Author

nuke-web3 commented Oct 12, 2021

Moved to homepage = "https://substrate.io" throughout.

I ran cargo +nightly fmt with today's toolchain. This had a code format change in:

  • client/network/src/service.rs
  • primitives/keystore/src/testing.rs

This right?

@gilescope
Copy link
Contributor

Try doing a cargo fmt with 2021-09-01 nightly (which seems to be the nightly that it's using, though confusingly there seem to be two nightly versions installed).

@athei athei added the D3-trivial 🧸 PR contains trivial changes in a runtime directory that do not require an audit label Oct 13, 2021
@nuke-web3 nuke-web3 merged commit 66296a0 into master Oct 13, 2021
@nuke-web3 nuke-web3 deleted the ds/all-links-to-docs branch October 13, 2021 18:56
@nuke-web3
Copy link
Contributor Author

nuke-web3 commented Oct 14, 2021

My sincere apologies: I did not see the A7 tag here the bot added! Does this need to be reverted? What Polkadot PR is needed that triggered this?

At least this I figure: paritytech/polkadot#4076

Also, what should be noted in the next release? Should this be in the change log at all?
I am not sure if there is any ramification on crates.io for instance cc @gnunicorn .

@gilescope
Copy link
Contributor

I don't know why it added that flag. The polkadot companion build was fine - everything was green before merge so you should be good (esp as this is just docs change).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-please_review Pull request needs code review. 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
Development

Successfully merging this pull request may close these issues.

5 participants