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

Improve Build Docs and Agile Coretime - Coreify The Build Section #5811

Merged
merged 21 commits into from
May 7, 2024

Conversation

CrackTheCode016
Copy link
Contributor

@CrackTheCode016 CrackTheCode016 commented Apr 23, 2024

This PR focuses mainly on issue #5799, but also solves at least one aspect from issue #5793.

NOTE: This PR has focused on adding this to the Kusama Wiki, not Polkadot. As such, expect chaos.

  • Ports install instructions from Substrate.io to the Wiki for ease of use.
  • Creates the "Getting Started with Coretime" Section under Build for Kusama
  • Nukes references to substrate.io (mostly outdated) to polkadot-sdk-docs instead
  • More concise explanations in build-guide

@CrackTheCode016 CrackTheCode016 added the A1 - In Progress Not ready for review yet. label Apr 23, 2024
@CrackTheCode016 CrackTheCode016 self-assigned this Apr 23, 2024
@CrackTheCode016 CrackTheCode016 mentioned this pull request Apr 23, 2024
6 tasks
@CrackTheCode016 CrackTheCode016 added A2 - Please Review Pull request is ready for review. and removed A1 - In Progress Not ready for review yet. labels Apr 24, 2024
@CrackTheCode016
Copy link
Contributor Author

Please note, that to ensure the PR can be properly reviewed, follow up PRs for the new section and concerning the guides will commence after this one is merged.

@filippoweb3 filippoweb3 linked an issue Apr 25, 2024 that may be closed by this pull request
@DrW3RK
Copy link
Member

DrW3RK commented Apr 25, 2024

Good work!

Coretime has yet to be launched on Polkadot (it takes a month or two), so modifying the concrete build section on the Polkadot Wiki is not recommended. Perhaps, do a conditional render for this new content to be shown only on the Kusama guide and modify just the Kusama sidebar with the newly added pages?

Right now, https://wiki.polkadot.network/docs/learn-agile-coretime-index caters to different audiences who are trying to learn about coretime through definitions and tutorials. We can keep the structure as is. Deleting pages on the Wiki is not recommended (without conditional rendering). For the coretime for parachains, we can retain the page in the learn section and have some insightful content live there. We can move the adder tutorial to the new page you have tried to create in the build section.

@CrackTheCode016
Copy link
Contributor Author

@DrW3RK That is fair, I got a bit too enthusiastic it seems 😁 how about the following?

  • Modify to remove aspects related to core deployment on the main page; that way, we can keep updated doc links, just not reference coretime since it is the main reference. These can be added later once it is merged in Polkadot
  • Keep learn for parachains in the Coretime section
  • Keep the new section for builders, and add a banner indicating that these guides are only for Kusama and Rococo and not deployed for Polkadot yet. I could also just modify the Kusama sidebar, if that works better you think. WDYT?

@CrackTheCode016 CrackTheCode016 added the A0 - Do Not Merge Pull request should not yet be merged. label Apr 25, 2024
@CrackTheCode016 CrackTheCode016 added A1 - In Progress Not ready for review yet. and removed A2 - Please Review Pull request is ready for review. labels Apr 25, 2024
Copy link
Member

@DrW3RK DrW3RK 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 the update of these build pages. Added a few suggestions.

Some comments:

  • Do we want to move the dependency installation docs from substrate.io to the Wiki? Doesn't it make sense for these installation docs to live on Polkadot SDK docs?
  • Make sure there are a few reviews from the devs for these changes to the Wiki docs before pushing them on to Wiki.

docs/build/build-guide.md Outdated Show resolved Hide resolved
docs/build/build-guide.md Outdated Show resolved Hide resolved
docs/build/build-guide.md Outdated Show resolved Hide resolved
docs/build/build-guide.md Outdated Show resolved Hide resolved
docs/build/build-guide.md Outdated Show resolved Hide resolved
docs/build/build-guide.md Outdated Show resolved Hide resolved
docs/build/build-guide.md Outdated Show resolved Hide resolved
docs/build/build-guide.md Outdated Show resolved Hide resolved
docs/build/build-guide.md Show resolved Hide resolved
docs/build/build-guide.md Outdated Show resolved Hide resolved
@CrackTheCode016
Copy link
Contributor Author

CrackTheCode016 commented May 2, 2024

@DrW3RK

Do we want to move the dependency installation docs from substrate.io to the Wiki? Doesn't it make sense for these installation docs to live on Polkadot SDK docs?

I can get more feedback on this, but it makes more sense in the Wiki from my POV. Those specific docs on substrate.io are good, work well, and serve as as good basis for installing dependencies in general. I would generally like to get people away from substrate.io. If we get more feedback, I would happy to move them to polkadot-sdk-docs, if we feel it makes more sense, imo it fits well within the build section of the Wiki, as its fairly general.

@CrackTheCode016 CrackTheCode016 added A2 - Please Review Pull request is ready for review. and removed A1 - In Progress Not ready for review yet. A0 - Do Not Merge Pull request should not yet be merged. labels May 6, 2024
Copy link
Member

@DrW3RK DrW3RK left a comment

Choose a reason for hiding this comment

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

Thank you very much for this!

@DrW3RK DrW3RK merged commit d592a02 into master May 7, 2024
3 checks passed
@DrW3RK DrW3RK deleted the build-section-coretime branch May 7, 2024 07:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Please Review Pull request is ready for review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants