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

Beginnings of user documentation #4

Merged
merged 10 commits into from
Mar 25, 2020
Merged

Beginnings of user documentation #4

merged 10 commits into from
Mar 25, 2020

Conversation

waxlamp
Copy link
Contributor

@waxlamp waxlamp commented Mar 19, 2020

Here's an initial stab at user docs. The bulk of what I've added here (in multinet.rst) is a "tutorial" (using the two-axis model from that great talk on documentation), but I think that's where we want to start. I have plans to add a "reference" version of this tutorial, and then we will slowly need to add developer documentation too, but I see that as less urgent right now.

You can see the docs built from this branch here: https://multinet-app.readthedocs.io/en/user-docs/

Let me know what you think. @jtomeck, I'm especially interested in your opinion since you design for this project a lot, but don't necessarily test it out with actual use cases as often as the rest of us.

Closes multinet-app/multinet-client#10

@JackWilb
Copy link
Member

Great job on this so far, Roni. Thanks for all your hard work to get it to this point

@waxlamp waxlamp mentioned this pull request Mar 20, 2020
waxlamp and others added 3 commits March 20, 2020 10:14
Co-Authored-By: Jack Wilburn <jackwilburn@tutanota.com>
Co-Authored-By: Jack Wilburn <jackwilburn@tutanota.com>
Co-Authored-By: Jack Wilburn <jackwilburn@tutanota.com>
@waxlamp waxlamp marked this pull request as ready for review March 20, 2020 14:42
@waxlamp waxlamp requested a review from JackWilb March 20, 2020 19:59
Copy link
Member

@JackWilb JackWilb left a comment

Choose a reason for hiding this comment

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

Looks good to me. I think it's still a good idea to wait for @jtomeck's approval

Copy link
Member

@jjnesbitt jjnesbitt left a comment

Choose a reason for hiding this comment

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

Just took a look after building locally, looks good! Really great work.

Copy link

@jtomeck jtomeck left a comment

Choose a reason for hiding this comment

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

Couple notes.

Server

  1. You don't need to run pipenv shell. You can just run pipenv run serve outside of the env and it works (for me, at least on mac)
  2. Can you add running docker-compose up on mac? I still have to use ARANGO_DATA=~/.local/multinet/arango docker-compose up

Client
I'm sure you know this, and there's probably a reason you have it split into 2 steps, but I usually combine 3 & 4 and run yarn && yarn serve to make sure I'm always up to date every time I serve.

EDIT: The only necessary change that I see is adding instructions for Mac above.

@waxlamp
Copy link
Contributor Author

waxlamp commented Mar 25, 2020

Server

  1. You don't need to run pipenv shell. You can just run pipenv run serve outside of the env and it works (for me, at least on mac)

This is definitely true, but I don't see pipenv shell in the quickstart instructions. Can you point me to where it's appearing?

  1. Can you add running docker-compose up on mac? I still have to use ARANGO_DATA=~/.local/multinet/arango docker-compose up

Thanks for catching this. See 62d4aa7.

Client
I'm sure you know this, and there's probably a reason you have it split into 2 steps, but I usually combine 3 & 4 and run yarn && yarn serve to make sure I'm always up to date every time I serve.

I guess I'm just being explicit about what the steps are. Doing it your way makes sure you're never out of date, but it causes the command to run a little longer. Not a big deal but I'm keeping it simple for the documentation.

@waxlamp waxlamp requested a review from jtomeck March 25, 2020 16:23
@jtomeck
Copy link

jtomeck commented Mar 25, 2020

This is definitely true, but I don't see pipenv shell in the quickstart instructions. Can you point me to where it's appearing?

It's not there now, I started this yesterday and resumed this AM, so it may have changed in the short amount of time. I refreshed and now I'm seeing it differently. This is what I WAS seeing prior to refreshing:
Screen Shot 2020-03-25 at 12 39 44 PM

I guess I'm just being explicit about what the steps are.

Yup that's why I wasn't saying to change it, just letting you know what I do in case you thought cutting down on steps was important.

@waxlamp waxlamp merged commit a0d6a31 into master Mar 25, 2020
@waxlamp waxlamp deleted the user-docs branch March 25, 2020 16:46
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.

Add user documentation
4 participants