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

Update aragonCLI documentation #99

Merged
merged 22 commits into from
Mar 10, 2019
Merged

Conversation

0xGabi
Copy link
Contributor

@0xGabi 0xGabi commented Feb 27, 2019

close #15, #33, #53 , #70, #74, #76 , #77

This PR will be used to commit the changes listed in #87

@delfipolito @sohkai @0x6431346e I would like to have your feedback about adding a new section including different Guides

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
@sohkai
Copy link
Contributor

sohkai commented Feb 27, 2019

Adding a new section including different guides

I think this makes sense; we could move the current app tutorial to be under this new section as the first guide (leaving the "your first app" tutorial in the header as is)?

@0xGabi
Copy link
Contributor Author

0xGabi commented Feb 28, 2019

Yes! Great idea

@delfipolito
Copy link
Contributor

I like it! 💯

0xGabi added 3 commits March 1, 2019 15:50

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
0xGabi added 4 commits March 1, 2019 19:11

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

## aragon apm grant

Grant an address (group of addresses) permission to create new versions in the package define in the `arapp.json` file, by interacting directly with the ACL, without performing transaction pathing.
Copy link
Contributor

Choose a reason for hiding this comment

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

package define in the

defined

Copy link
Contributor

@kernelwhisperer kernelwhisperer left a comment

Choose a reason for hiding this comment

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

Nice work!! 🚀
(I haven't reviewed the guides/faq sections yet, let me know when they are ready)

Also, there's something weird with the colors of the code snippets on my machine.
We might need to mark them with ```sh

Partially verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
Daniel's review

Co-Authored-By: 0xGabi <[email protected]>
@0xGabi
Copy link
Contributor Author

0xGabi commented Mar 7, 2019

@0x6431346e You are right about the colors in code snippets. I tried with ```sh and the code are only grey colored.

@delfipolito Are the code snippets color coding related with the style of the website?

0xGabi added 4 commits March 7, 2019 12:05

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
@0xGabi 0xGabi requested a review from kernelwhisperer March 7, 2019 20:57
@0xGabi
Copy link
Contributor Author

0xGabi commented Mar 7, 2019

Is ready for review. I decided to include Frame guide in the next iteration. All feedback is welcome 😄

@delfipolito
Copy link
Contributor

@0xGabi I didn't change anything about the code snippets on the redesign PR, so they should look the same

0xGabi added 3 commits March 8, 2019 12:29

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
@@ -20,7 +20,7 @@ npm install -g @aragon/cli

In order to deploy to rinkeby or mainnet using the CLI you will either need to use a hardware wallet with [Frame](https://frame.sh) or configure aragonCLI to [sign transactions using a private key](/docs/cli-faq.html#set-a-private-key).

If you decide to [use frame](guides-use-frame.md), just add `--use-frame` to any of these commands.
If you decide to use frame, just add `--use-frame` to any of these commands.
Copy link
Contributor

Choose a reason for hiding this comment

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

*Frame with uppercase F

Copy link
Contributor

@kernelwhisperer kernelwhisperer left a comment

Choose a reason for hiding this comment

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

LGTM!

kernelwhisperer and others added 3 commits March 10, 2019 19:26

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

Partially verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
Co-Authored-By: 0xGabi <[email protected]>
If you want to learn how use environments in practice check the guides to learn [how to publish in diferent environments](guides-publish.md).


## The manifest.json file
Copy link
Contributor

Choose a reason for hiding this comment

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

@bpierre We will likely want to update this soon.

@sohkai
Copy link
Contributor

sohkai commented Mar 13, 2019

@delfipolito @owisixseven What do you think about making it easier to access the guides / tutorials from the home page? From a first glance, it's hard to know these guides even exist, and you have to click to one of the specific areas (e.g. aragonCLI) and look at the sidebar to know that these guides exist.

I had a hard time finding them even though I knew they were there somewhere 😅.

@ghost
Copy link

ghost commented Mar 13, 2019

Good point @sohkai let me work on it!

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.

Sanity check Your First Aragon App
5 participants