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

Draft: Improved getting-started page #139

Merged
merged 90 commits into from
May 17, 2019
Merged

Draft: Improved getting-started page #139

merged 90 commits into from
May 17, 2019

Conversation

unixpi
Copy link
Contributor

@unixpi unixpi commented Apr 23, 2019

Hi everyone, excited to be making my first pull request here 😊. This is a draft PR for async comments (as @0xGabi requested).

The aim here is to make the getting-started page as accessible as possible. In particular, it should be accessible to developers with no prior web3 experience.

Note that this is very much still a work in progress. Some subsections need to be heavily edited, while others still need to be filled in. The general structure will also no doubt evolve.

I think an important thing that's missing right now are the prerequisites. Stating them explicitly will force us to think hard about what exactly needs to be included, and make sure the whole thing is entirely self-contained for those who meet them.

Thanks for reading. Looking forward to hearing your thoughts!

started work on issue aragon#104 + empathy for web3 newbies.
Fix typo + edit.
Add Mac considerations
Add empathy to quick start
start fleshing out 'What is Aragon and what does it do'
add introduction
add further reading subsection to intro
Flesh out 'More on DAOs' subsection
minor edits + ellipses as placeholders
intro edits: clarify link between Aragon Apps and DAOs
start fleshing out web3 subsection
web3 subsection additions + edits
web3 subsection: add web2 vs web3 stack image + edits
environment setup edits. start fleshing out web3 provider text
Metamask subsection: quote update
Up and running: lots of little edits
add placeholders for tomorrow
Metamask subsection: add instructions modulo images
Metamask subsection: add images + edits
Interacting with your first DAO subsection: add instructions
Fix error: cannot generate application artifact:   Illegal char _

(The name of an App can't have an underscore)
@0xGabi
Copy link
Contributor

0xGabi commented May 13, 2019

Hey @hackingclimate I just submit #148 can you take a look when possible. Thanks

@unixpi
Copy link
Contributor Author

unixpi commented May 13, 2019

Hey @0xGabi, had a look and left a comment: #148 (comment)

I think it's a great start.
I will take some time today to edit.
If you agree with my comment I can integrate my suggestion.
Will also mirror you and convert the MetaMask guide from a blog post to markdown.
I think we should be good to merge this either tonight or tomorrow!

@unixpi
Copy link
Contributor Author

unixpi commented May 13, 2019

@0xGabi, left some more suggestions on #148. On my side, Metamask guide is ready for review.

Here's the link to the guide in blog post format:
https://medium.com/@sachastleger_80263/getting-started-with-aragon-metamask-guide-cb78d54934a9

And here's the md version (docs/guides-use-metamask.md): https://github.com/hackingclimate/hack/blob/patch-1/docs/guides-use-metamask.md.

@unixpi
Copy link
Contributor Author

unixpi commented May 14, 2019

@0xGabi can't seem to find a way to connect Frame to Localhost 8545. If it can't be done, I think we should consider moving the Signing your first transaction with Frame section from the getting started page to the tutorial.

The logic being: the user can't interact with first-dao using Frame, and the point of the getting started page is to launch -- and interact with -- first-dao. What do you think?

We can't use Frame to interact with the Getting started page app (see aragon#148 (comment)).
As a result, the user should use Metamask. To avoid confusing the user, better to introduce Frame in the tutorial page.
@unixpi
Copy link
Contributor Author

unixpi commented May 16, 2019

@0xGabi here are some updates on my side:

  • I've created a markdown version of the GitHub tutorial (docs/github-guide.md) and linked to that instead of the blog post: this is consistent with the other tutorials and allows us to keep updating / editing after we've merged.

  • I've removed the introduction to Frame (for the time being). Bear with me here. The logic is that since we can't use Frame to interact with the first-dao app right now (see How to use Frame #148 (comment)), the user has to use Metamask. To avoid confusing the user, I think it's better to wait until the tutorial page to properly introduce Frame.

Note that Frame is still mentioned in the second paragraph of the Web3 provider section:

In general, if you have a hardware wallet, we recommend you use Frame as your web3 provider -- we'll go over how to do this in the tutorial that follows. To interact with the app in this section however, we'll be using Metamask.

And it's clear that it's our preferred provider.

Tomorrow I'd like to start doing the same thing for the tutorial page -- i.e. make it accessible to developers with no prior web3 experience by explaining everything from first-principles. I propose to do this in a different pull request.

What are your thoughts on all the above? Apologies if the tone is quite brusque! I haven't had much time to write this.

@0xGabi
Copy link
Contributor

0xGabi commented May 16, 2019

Hey @hackingclimate thanks for the update. I'll review both articles and make them ready to merge.

docs/getting-started.md Outdated Show resolved Hide resolved
@0xGabi
Copy link
Contributor

0xGabi commented May 16, 2019

@hackingclimate I fixed some small things on getting start file.

Then made some style changes on the Metamask tutorial. I removed some of the image that seems repetitive.

I think this is ready to be merged.

I have a couple of comments for the GitHub tutorial:

  1. We need better quality images. Also it would be great as a general guide follow the same size to improve style on the final documentation.
  2. Not sure if we should include this tutorial on hack. Or this should be part of the documentation on the repo but not part of the actual website.

@unixpi
Copy link
Contributor Author

unixpi commented May 16, 2019

@hackingclimate I fixed some small things on getting start file.

Then made some style changes on the Metamask tutorial. I removed some of the image that seems repetitive.

I think this is ready to be merged.

@0xGabi awesome. Thanks for taking the time to review.

  1. We need better quality images. Also it would be great as a general guide follow the same size to improve style on the final documentation.

Agree. Images were for the first draft. Will standardize sizes -- perhaps a standard and another for close ups -- and replace with higher quality tomorrow.

  1. Not sure if we should include this tutorial on hack. Or this should be part of the documentation on the repo but not part of the actual website.

Leaning towards the latter (documentation on the repo) since it isn't needed to create apps. What do you think?

@0xGabi
Copy link
Contributor

0xGabi commented May 17, 2019

I'll go ahead and merge this PR and you can create a new one to update the GitHub tutorial images. I decide to create a new folder docs-internal for this type of documents. We should add a link on the Contributing file.

@0xGabi 0xGabi merged commit 3bb409d into aragon:master May 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants