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

Explicitly state installation requirements in docs #703

Closed
maxalbert opened this issue May 3, 2019 · 1 comment · Fixed by #713
Closed

Explicitly state installation requirements in docs #703

maxalbert opened this issue May 3, 2019 · 1 comment · Fixed by #713
Labels
docs Documentation issues

Comments

@maxalbert
Copy link
Contributor

The docs should have a clear and easy-to-discover section about installation requirements (probably on the How to Install FlowKit page).

This should mention the minimum (& recommended) versions of Python and docker, for both users and developers.

It should also have a brief overview (diagram?) of the architecture, so that users understand under which circumstances they only need to care about installing FlowClient, vs. all FlowKit components.

It would be good to accompany this with a couple of "usage scenarios" - for example, demonstrating how a user would connect to an already-existing production FlowKit installation vs. if they want to set up the demo system on their own laptop.

@maxalbert maxalbert added the docs Documentation issues label May 3, 2019
@greenape
Copy link
Member

greenape commented May 7, 2019

FlowClient & FlowMachine (client): Python 3.6
FlowMachine server: Python 3.7
FlowKit: Docker 17.12.0, compose 1.21.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants