polkadot-wiki icon indicating copy to clipboard operation
polkadot-wiki copied to clipboard

Migration of how-to guides in the General and Basics sections to the Support page

Open michalisFr opened this issue 2 years ago • 19 comments

We can use this issue to find and settle on the how-to guides in the wiki that need to migrate to the Support page and track the progress of the migration. I'll update this post with a task list for each guide as we find them.

  • [X] Find all how-to guides in the General and Basics wiki sections that need to migrate to the support page
  • [X] Settle on the list of articles to migrate below
  • [x] Prepare (create/update) all articles below
  • [ ] Remove/update corresponding wiki articles

Articles to migrate


  • [ ] Polkadot claims: The whole article can be removed. Update the support article with steps of the claim process. Remove account creation material and instead link to relevant articles. (Low priority)

Each section has/needs its own article basically:

  • [X] Ledger Live: Article exists
  • [X] Loading your account: Articles exist for the UI and the extension
  • [x] Confirming the address on your device: We need to create this article. New article
  • [X] Checking the balance: Article exists (for all types of accounts)
  • [X] Sending a transfer: Article exists. Update with instructions on how to sign based on the specific account type (see Balance Transfers below). New article
  • [x] Receiving a transfer: We need to create an article for types of accounts. New article
  • [X] Staking: Article exists
  • [x] Removing expired democracy locks: We need to create that article for all types of accounts with specific mention to Ledger (we need to check if the batch call is supported first). New article

  • [x] Statemint: We need to create that article that refers both to Statemine and Statemint with short explanation of sufficient and non-sufficient and the scams warning (to migrate transferring assets). Leave Creating assets on the wiki. There is also this article about transferring USDT. New article
  • [x] Teleporting: Update support article with the remarks at the top of the Teleport section before migration.


Specifically for each section:

  • [X] Key security: Create article with basic security practices for mnemonic phrases and link to "learn scams" for more info. New article
  • [X] Extension: Update article with step-by-step instructions. Updated article
  • [X] Subkey: Article exists
  • [X] Polkadot-JS UI: Article exists (multisig accounts will be covered in the other article above)
  • [X] Parity Signer: Article exists
  • [X] Ledger: Articles exist for the UI and the extension
  • [X] Vanity generator: Article existed. Updated article

  • [X] Backing up and restoring accounts: All the sections exist as support articles (with different structure) so this whole article can be removed. Keep on the wiki only the last one Transferring accounts from one computer to the other but as its own article.

Specific articles:


  • [X] Balance transfers: Article exists. Replace the section after the transfer button with links to new articles on how to sign depending on the type of account. Updated article

More specifically:

  • [X] Polkadot-JS UI: Move information from current article to new article on signing with an account on Polkadot-JS UI. New article
  • [X] Polkadot extension: Move information from current article to new article on signing with an account in the Polkadot extension. New article
  • [X] Parity Signer: Create new article on how to sign with Parity Signer, with both options injected (extension) and external (UI). New article
  • [X] Ledger: Create article on how to send with your Ledger, with both options injected and ledger that includes instructions for actions on the device too. New article

  • [X] Staking FAQ: This whole article can be migrated to the support page (and enriched) and removed from the wiki. So we need to create a Staking FAQ article that may also serve as a central point to staking questions/problems with links to other articles. New article
  • [X] Nomination Pools: Migrate only the Pool member lifecycle and leave the rest (intro and Pool administration. Create a new article ("How to nominate with nomination pools"). New article

Migrate the following sections (and create a new folder for them):

  • [X] Setting an identity: Create new article that includes the UI way with the supported fields, but excludes the custom fields and format caveats. These parts should remain on the wiki. New article
  • [X] Requesting judgement & cancelling judgement: Create new article. The intro section should remain on the wiki. New article
  • [X] Sub accounts: Create new article and migrate. New article
  • [X] Clearing identity: Create new article and migrate. Section added to "Setting identity" article
  • [X] W3F registrar: Article exits.

  • [X] Treasury: Don't migrate but create an article on how to tip and link to it from the corresponding wiki example. New article

michalisFr avatar May 16 '22 15:05 michalisFr

General Section

Polkadot Claims - We have an article for this already, however, it is outdated. The support article is mostly comprised of how to create an actual account. I think we could migrate this and update the guide. Although I don't know how much this is needed since most have claimed by now. Personally it's been a long time since I've seen a claims ticket.

Polkadot Ambassador Programme - Not a guide, but this could perhaps be migrated to a support article.

Using ENS w/ DOT/KSM accounts - In my opinion this should stay on the wiki - too advanced/specific.

Using the Polkadot Ledger Application - Parts of this article can be migrated, as we already have support articles for both adding Ledger to extension and Polkadot-JS UI. However, "using the dev release" section should stay on the wiki, along with the section on democracy locks.

Programmes - I believe this section should stay on the wiki as it pertains to programs rather than support.

keeganquigley avatar May 20 '22 17:05 keeganquigley

Tokens and Assets Section

DOT - the How To Obtain Westies guide could be migrated to a support article. Everthing else can stay on the wiki.

Statemint - the Transferring Assets on Statemint guide could be migrated to an article. I would argue though, that creating assets is an advanced topic, therefore the Creating Assets guide can stay on the wiki.

Teleporting Assets - there is already an article for this which links to the wiki for more advanced info. I don't think anything needs to be added to this currently, as the wiki gives more in-depth information on how teleporting works.

keeganquigley avatar May 20 '22 22:05 keeganquigley

Accounts section The guide on creating a multisig account on Polkadot-JS UI can be migrated to a support article.

Recommendations on storing your key and JSON file securely can be combined with similar recommendations from the General section about scams and reworked into a support article.

The guides on creating accounts in the extension, Subkey, Polkadot-JS UI, and Parity Signer can be migrated. There already are support articles about creating an account in the extension (certainly can be expanded), Subkey (it's more informative than in the Wiki), Polkadot-JS UI, and Parity Signer.

The guides on exporting your backup file and restoring your account with it in the extension and Polkadot-JS UI can be migrated, but probably also need a change of structure. There is a separate support article that cover export of backup file both in the extension and UI. Restoring with your backup file is part B of the articles about restoring in the extension and UI.

The guide on restoring your account with its seed in the extension and UI can also be migrated. It's part A of the articles mentioned above: restoring in the extension and UI.

The guide on restoring in Parity Signer can be a link to the corresponding support article.

The guide on sending funds comes in two parts: from Transfer and from Accounts. We have one support article for both ways.

Staking section The staking guide on Polkadot-JS UI can be migrated to the support article we already have.

It's not a guide, but the list of reasons for not receiving staking rewards can be migrated too, we have a support article about it.

alineherzman avatar May 23 '22 16:05 alineherzman

Identity: The guides on how to set an identity, requesting judgement, creating a subidentity and clearing an identity should be migrated. The registrars sections should stay on the wiki. We have a How to use the W3F registrar that should accompany these articles (and perhaps create a section about identity).

Nominator: There is some overlap with the bags list article and the active/inactive/waiting article, but I don't think there are any guides needing migration. Instead we should link to these wiki articles in the support articles.

W3F Registrar: This is an empty article. We can remove it entirely or link to W3F Registrar article on the Support page.

Transaction fees: This doesn't need migration, but perhaps we could write an article in the future about this, if transaction ever become an issue. For now I don't think any action is needed.

Treasury: Hmm, that's a tough one. I'd say let's create an article on how to tip. We want people to participate more in the spending of treasury and tipping is an easy entry point compared to spending proposals or bounties, which should remain on the wiki. The "Tipping" section should also remain in the wiki as is, but in the "Example" section we can add a link to the support article. And in the Support article a link to the "Tipping" section and the "Treasury" article overall for "learn more".

All the other articles of the "Components" section don't have anything that could be migrated to the Support page.

michalisFr avatar May 24 '22 13:05 michalisFr

Reviewed the list of articles to be migrated. Agreeing with all the proposed actions.

Although, complete removal of docs like "Staking FAQ", "Polkadot claims" etc. which may have been referenced by external parties may not be a good idea. We could update the articles to have a summary and the respective forwarding links to Support page. For instance, the Staking FAQ could include questions pertaining to Phragmen algorithm, Polkadot runtime limitations etc. and a forwarding link to the support article on Staking FAQ.

The Wiki articles can be updated to answer "Why?" more than "How to?"

BTW, updated the W3F registrar doc with a forwarding link to Support page https://github.com/w3f/polkadot-wiki/pull/3366

DrW3RK avatar May 25 '22 09:05 DrW3RK

@DrW3RK I've updated the list. All checked articles are ready to be migrated and I've added links to the specific support articles. The Restore section is ready for migration in its entirety.

I didn't change the language about "removing" articles, but I agree with your point, so let's have these mean what you proposed. And I agree with this too:

The Wiki articles can be updated to answer "Why?" more than "How to?"

@keeganquigley Please divide the remaining articles between you, me and @alineherzman. I've bolded keywords like update or create to specify what each article needs. New articles or articles that need a serious update should be done in accordance with the style guide, so that we don't need to go over them again.

I'd recommend that we tackle them section by section so that we finish with the migration of one section before moving to the next. So, we could start with Balance transfers, do that, then move to Ledger and so on.

michalisFr avatar May 25 '22 16:05 michalisFr

Thanks @michalisFr I have tried to divide as evenly as possible. There are 17 creates and 5 updates so far, so I have split up tasks as follows:

@michalisFr Using the Polkadot Ledger Application Statemint Teleporting Multisig creation and usage

@alineherzman Account generation Balance transfers

@keeganquigley Staking FAQ Nomination Pools Identity Treasury

This way we each have a total of (7) subtasks. I skipped the Polkadot claims for now. I'm aiming to have the style guide finished by the end of this week. Let me know if this works and if you have any comments/questions!

keeganquigley avatar May 26 '22 18:05 keeganquigley

For Identity instructions, check if this feature request can be addressed. Thanks https://github.com/w3f/polkadot-wiki/issues/3353 and for Statemint, this one https://github.com/w3f/polkadot-wiki/issues/3282

DrW3RK avatar Jun 04 '22 09:06 DrW3RK

@keeganquigley @DrW3RK @alineherzman My parts are done.

For this article on how to send funds, once we have created separate articles for each account type, like this one for Ledger, as described in the Balance Transfers section, we need to rewrite it with clear numbered steps for the part that is common for all account types and then link to each separate article from then on. And in each separate article we'll have a "Initiate the transfer as described in this article" step, like step 2 in the Ledger article.

michalisFr avatar Jul 01 '22 15:07 michalisFr

@michalisFr @alineherzman my sections are complete!

Note: I didn't end up creating a separate article for Clearing an Identity, as it is so short; I combined it with the Set Identity article.

keeganquigley avatar Jul 15 '22 18:07 keeganquigley

@keeganquigley As you were working on Identity section, can you find a home for this caution as well https://github.com/w3f/polkadot-wiki/issues/3516

DrW3RK avatar Jul 15 '22 20:07 DrW3RK

@keeganquigley Can you please post links to the articles in your sections so I can update the OP?

michalisFr avatar Jul 19 '22 10:07 michalisFr

@DrW3RK All articles are ready except the claims one. You can remove content and add the links to the wiki at your convenience.

michalisFr avatar Jul 19 '22 17:07 michalisFr

Thank you! We will get started with the content removal beginning next week.

DrW3RK avatar Jul 20 '22 10:07 DrW3RK

@keeganquigley @alineherzman Do any of you want to grab the claims article? It's the only one left in our list

michalisFr avatar Aug 01 '22 12:08 michalisFr

@keeganquigley @alineherzman Do any of you want to grab the claims article? It's the only one left in our list

Sure no prob, I can grab this.

keeganquigley avatar Aug 01 '22 14:08 keeganquigley

Claims article has been published. @DrW3RK I left out the Parity Signer section, this can stay on the wiki, although the UIs are outdated.

keeganquigley avatar Aug 03 '22 19:08 keeganquigley

@keeganquigley Yeah, the PR to update Parity Signer doc is blocked

The last update on Parity Signer was that it is still being reviewed -

Gav (Jun 28th) "i had time to reevaluate signer (5.1.0). there's still some important stuff which needs to be addressed. should i write up here or would a call be more useful?"

Should probably follow up

https://github.com/w3f/polkadot-wiki/pull/3059

DrW3RK avatar Aug 04 '22 08:08 DrW3RK

I believe the final bullet point in this issues description is now complete

  • [x] Remove/update corresponding wiki articles

There are still a couple open PRs in review. Please let me know if there are any outstanding items that still require action.

I am going to start on https://github.com/w3f/polkadot-wiki/issues/3597 next.

alfarok avatar Aug 25 '22 17:08 alfarok