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

Rehauling Coretime x Omninode x Template Guides #6251

Open
19 tasks
CrackTheCode016 opened this issue Sep 23, 2024 · 2 comments
Open
19 tasks

Rehauling Coretime x Omninode x Template Guides #6251

CrackTheCode016 opened this issue Sep 23, 2024 · 2 comments
Labels
docs Related to the docs in general.

Comments

@CrackTheCode016
Copy link
Contributor

CrackTheCode016 commented Sep 23, 2024

With the arrival of Coretime on Polkadot, we are in need of several types of guides/tutorials to shed light on how to actually use it:

  • Using Coretime, aspects to consider (bulk renewal, more details on the sale period, etc)
  • Emphasizing the Omninode as a means for running networks (installing and using polkadot-parachain)
  • Deciding which template to pick, why you may pick one over the other

IMHO, these shouldn't one one coherent "end-to-end" guide, but rather a set of modular guides

Probably need two sets of docs: "Omninode Guides", and "Coretime Guides". The two are associated with each other, but it would be ideal to create some modular guides, where the coretime guides are general for any type of chain, and thus more maintainable. With omninode guides, it is rather straight forward, as it is mostly focused on chain-spec generation and the like.

Note: The template guides should be mostly covered by their respective READMEs, however this will cover some beginner stuff and point to those READMEs anyway

Each top-level "Guides" item will be its own drop-down section, and each subsequent item will be a separate page.

  • Template Guides
    • Installing Polkadot SDK Dependencies
      • Section(s) for installing polkadot-parachain and chain-spec-builder
    • Choosing your template (the idea is, you can choose any template, and any of these instructions would apply with the exception of parachain related stuff)
    • Compiling & Customizing your template
      • Adding new pallets / dependencies (i.e., adding pallet_nft)
      • Creating a simple pallet and adding it as a local dependency
  • Omninode Guides
    • General introduction to what an omninode even is
    • Using polkadot-parachain
    • Generating a chain-spec with chain-spec-builder (basic chain spec, then with a patch.json and how to do that)
    • Configuring chain-spec-builder for different scenarios (parachain and solo, namely)
    • Configuring polkadot-parachain for different scenarios (running with alice, --dev, or as a normal collator for a parachain)
  • Coretime Guides (note for these, we can port existing documents and update them most likely)
    • How Coretime Works
    • Buying Coretime
    • On-demand vs. Bulk Coretime
    • Maintaining Coretime Rentals
    • Registering your Parachain on a Core
@CrackTheCode016 CrackTheCode016 added the docs Related to the docs in general. label Sep 23, 2024
@nhussein11
Copy link
Contributor

Disclaimer: The following three sections are currently not included in our IA, but they can definitely be added since these topics will be very helpful for tech teams in the near future. At the moment, we have no documentation on these topics

Totally agree here:

it would be ideal to create some modular guides, where the coretime guides are general for any type of chain, and thus more maintainable. With omninode guides, it is rather straight forward, as it is mostly focused on chain-spec generation and the like.

Template Guides

I think the whole Template Guides section should live directly under the polkadot-docs. It would make sense for devs to count on all that info on the same website for a smooth learning experience. Also, we could reference portions of those Template Guides for future in-depth tutorials or advanced guides.

Omninode Guides

Not sure exactly what you're planning to cover with "Using polkadot-parachain" (could you elaborate further, @CrackTheCode016)? But for these items:

  • Generating a chain-spec with chain-spec-builder (basic chain spec, then with a patch.json and how to do that)
  • Configuring chain-spec-builder for different scenarios (parachain and solo, namely)
  • Configuring polkadot-parachain for different scenarios (running with alice, --dev, or as a normal collator for a parachain)

I think that it also makes sense to include them on polkadot-docs (same reasons as above)
For General introduction to what an omninode even is i think it's okay that it lives in the wiki

CoreTime Guides

Registering your Parachain on a Core is the only one that would make sense to have in the polkadot-docs, at least in my opinion

@nhussein11
Copy link
Contributor

Also, I'm wondering if some of the Template Guides would overlap with this section https://docs.substrate.io/tutorials/build-application-logic/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to the docs in general.
Projects
None yet
Development

No branches or pull requests

2 participants