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

Provide guidance on how to install the app in the user manual and/or the github READMEs #177

Open
fBedecarrats opened this issue Dec 8, 2019 · 5 comments
Assignees

Comments

@fBedecarrats
Copy link

Is your feature request related to a problem? Please describe.
As an outsider interested in Arcade Analytics, I found it very hard to figure out how to install it and get it running. The user manual provides no guidance about how to install the application. The readme file on the arcadeanalytics repository doesn't describe how to obtain and run the docker image. The content of the docker image doesn't run out of the box. To run the application, one needs to fetch additionnal yml files from the arcadeanalytics-recipes repo, include them into the base image and edit the app.yml file. This is not trivial and this is not descibed in the READMEs.

Describe the solution you'd like
A description of the step-by-step process one needs to follow to pull and run the application. This description could be inserted in the user manual and/or on the readme files of the arcadeanalytics and the arcadeanalytics-recipes repositories.

Describe alternatives you've considered
I started writing something in a comment on the issue #173, but it is probably not the most convenient/recommended solution and this issue is now closed and hardly visible by other users. I would be happy to help writing or reviewing something (with an outsider newbie perspective).

@arcade-player
Copy link
Contributor

"To run the application, one needs to fetch additionnal yml files from the arcadeanalytics-recipes repo, include them into the base image and edit the app.yml file. This is not trivial and this is not descibed in the READMEs."

What do you mean by " include them into the base image ".

We created the recipes repository to not force people (not developers) to deal with the code while they are only interested to test the application as-is.

Maybe we can bring back all to a single repo.

@arcade-player arcade-player self-assigned this Dec 8, 2019
@fBedecarrats
Copy link
Author

I think the app is wonderful, but there is no way for non-developers to figure out how to obtain, install and run it. I don't know if it is better to separate the files or bundle them together. But for sure, there should be a step by step guidance somewhere to explain how to go from "hmm, this app seems interesting" to "hey, it works and it fits my needs". Congratulations for this great work!

@arcade-player
Copy link
Contributor

we should fill the gap between the recipes readme and the manual

https://github.com/ArcadeData/arcadeanalytics-recipes

https://arcadeanalytics.com/usermanual/

the plan is to move the manual on ascidooc and integrate it into the build infrastructure

@arcade-player
Copy link
Contributor

We will rework documentation and manual. The goal is to unify the online manual (more related to our SAAS offer) to the readme/installation manual. Stay tuned (it's a boring task :) )

@fBedecarrats
Copy link
Author

Many thanks for your reactivity. I believe this will boost the uptake of this app. I will be happy to assist to the best of my ability.

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

No branches or pull requests

2 participants