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

Add Troubleshooting and FAQ section #591

Closed
wants to merge 9 commits into from
Closed

Conversation

nuke-web3
Copy link
Contributor

@nuke-web3 nuke-web3 commented Nov 21, 2021

This PR was originally called "Use Apps UI use without scale-info" . We agreed to alter the PR and create a section for the information it was originally putting forward.

Originally it:

With @sacha-l 's recent updates, it now:

  • Adds a section in our docs called "Troubleshooting and FAQ"
  • Add a page that contains information on: how to use PolkadotJS apps with a Substrate runtime that doesn't have the new scale-info pallet and how to use --dev without the (now) default --tmp.

This directly addresses #631 . Going forward, this section can be used by the support team and slowly will morph into the "FAQ dump" page idea the docs team has been pondering about.

@sacha-l
Copy link

sacha-l commented Nov 22, 2021

@nukemandan : I think that having both paths is comprehensive and a nice ting to have, but I think we should just specify in the "Before you begin" section that this tutorial expects using a node template that includes the scale-info pallet. As a general rule, we should always try and provide a single path forward. WDYT @lsgunnlsgunn ?

@lsgunnlsgunn
Copy link
Contributor

Yes, a single path in anything procedural or instructional. When you talk about a subject (informationally, conceptually, it is fine to mention that there's more than one way to skin the cat, but, in general, opt for a single path and in most cases not the "shortcut" path like keystroke combinations).

@sacha-l
Copy link

sacha-l commented Nov 23, 2021

@nukemandan : An idea came to mind: let's use this content and put it in the "Troubleshoot common issues" section of our new docs. I'm sure folks will run into needing to know this at some point. WDYT?

Copy link

@Eve-Parity Eve-Parity left a comment

Choose a reason for hiding this comment

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

Generally speaking, notes, cautions, and warnings usually take the following format (only one > is necessary - maybe the auto formatting kicked in):

NOTE: f;alsjiwalalajs;goijas;ofj;s;lfjfj
dshfa;sfjasdjf;alsjf;asjf;aj
ldskjfal;sfj;sjf

@sacha-l
Copy link

sacha-l commented Nov 24, 2021

@nukemandan @lsgunnlsgunn @Eve-Parity : I don't think this should get merged.

Co-authored-by: Eve-Parity <91919605+Eve-Parity@users.noreply.github.com>
@nuke-web3 nuke-web3 temporarily deployed to test November 25, 2021 11:46 Inactive
@nuke-web3
Copy link
Contributor Author

what is missing @sacha-l ? users downstream are hurting because this is not mentioned. we need it yk reference for support asap in some form

@nuke-web3 nuke-web3 temporarily deployed to test November 25, 2021 11:53 Inactive
@sacha-l
Copy link

sacha-l commented Nov 25, 2021

The content you're adding is out of context: the tutorial should maintain a "single path approach". In #607 I included a commit that removes the step for adding custom types (also ensuring that other tutorials aren't misleading in that way). If anything (as suggested above), the explanation should be brief and included in the "Before you begin" section (or some other part of our docs that caters to "conceptual" or "explanatory" types of content).

New comers doing our tutorials won't be juggling different versions of Polkadot JS apps. So I don't think its necessary to show them how to go back a version — at least not here. And even though - we should always be pushing folks to using the latest (and factor in our maintenance costs).

@lsgunnlsgunn
Copy link
Contributor

I agree with @sacha-l this feels out of place. Can you create a separate standalone topic that covers the information you want to capture and we'll find a better home for it.

@lsgunnlsgunn
Copy link
Contributor

Tutorials are not the right place to put odds and ends of content. I see a lot of that kind of thing (most often these bits belong under the reference heading but we could collect a bunch of topics about polkadot JS as a starting point).

@nuke-web3
Copy link
Contributor Author

nuke-web3 commented Nov 26, 2021

while I see your point guys, this has been a issue for support that needs a home and needs to be mentioned somehow in the docs. this week alone I have had no less than 5 users ask me thus question and they should have a solution to the problem available in the docs...

perhaps this is a good division of where I should work with our support team to create stack overflow and/or a dedicated trouble shooting page that we can deposit this content. We still absolutely need to mention thus in the docs, even if just a line or two on what the error they see may be and a link to such content.

We should resolve his to move forward on thus ASAP as a team in general 🙏

@sacha-l sacha-l temporarily deployed to test December 2, 2021 16:04 Inactive
@sacha-l sacha-l changed the title Use Apps UI use without scale-info Add Troubleshooting and FAQ section Dec 2, 2021
@sacha-l sacha-l temporarily deployed to test December 2, 2021 16:11 Inactive
@sacha-l sacha-l linked an issue Dec 2, 2021 that may be closed by this pull request
@nuke-web3
Copy link
Contributor Author

#478 and #477 solves these issues medium term. We should expose this in a separate PR that is versioned to use the right version of the apps UI -- moving to here: #667

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants