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

Further improvements of documentation #67

Open
smacker opened this issue Feb 7, 2018 · 14 comments
Open

Further improvements of documentation #67

smacker opened this issue Feb 7, 2018 · 14 comments
Labels

Comments

@smacker
Copy link
Contributor

@smacker smacker commented Feb 7, 2018

From @dpordomingo and @mcuadros comments:

or any other not-collapsed comments in the PR #29

@dpordomingo
Copy link
Contributor

@dpordomingo dpordomingo commented Feb 7, 2018

All my comments were collapsed (I don't understand why I did wrong :( ); I'll try to list them here.

@bzz bzz mentioned this issue Feb 14, 2018
@bzz
Copy link
Contributor

@bzz bzz commented Feb 14, 2018

Added a line to description on ENV VARs.

Update: #120 was created right after

@dpordomingo
Copy link
Contributor

@dpordomingo dpordomingo commented Feb 26, 2018

updated issue desc with updates on .env feature

@carlosms
Copy link
Contributor

@carlosms carlosms commented Feb 28, 2018

About this item:

explain better the features provided by our CLU and GUI #29 (comment)

I believe the current readme has a very good introduction. Does anyone have a specific suggestion on how to improve it, or can we mark it as done?

@smacker
Copy link
Contributor Author

@smacker smacker commented Feb 28, 2018

original comment got collapse. So here it is:

@dpordomingo :

With the current wording, I understand the following:

UI to annotate,
CLI to fetch (retrieve/download...) elements and to export.
But current app offers:

GUI UI to annotate and to review the annotations,
CLI to add/push/load fetch new elements to be annotated and to export the annotations made.
@campoy do you think we could reword this section to clarify the features offered by our app?

But for me README is clear in current state.

@bzz
Copy link
Contributor

@bzz bzz commented Feb 28, 2018

@carlosms to speed up the review and help understanding the scope that has been addressed - could you please update the checklist in PR description?

@carlosms
Copy link
Contributor

@carlosms carlosms commented Feb 28, 2018

@bzz 👍, main description is now up to date

@smacker
Copy link
Contributor Author

@smacker smacker commented Feb 28, 2018

Guys do you think we still need to document export in readme when we have a link in UI?

@dpordomingo
Copy link
Contributor

@dpordomingo dpordomingo commented Feb 28, 2018

I don't think so, it should be moved to other part of our docs (imo same reason as the one for import tool: this project is not focused in import/export databases, but in offering a web interface to annotate code and review code annotations)

@bzz
Copy link
Contributor

@bzz bzz commented Mar 1, 2018

I think it's worth to have import/export CLI documented but not in README.

As @smacker and @dpordomingo are right: we already have download for export and going to have upload for import soon, under new experiment management.

@carlosms do you think you could address this in #177 ?

@smacker
Copy link
Contributor Author

@smacker smacker commented Mar 1, 2018

Could anybody give me a reason why do we need CLI for import/export?

@carlosms
Copy link
Contributor

@carlosms carlosms commented Mar 1, 2018

@bzz:

@carlosms do you think you could address this in #177 ?

I'd rather merge #177 as it is, and do this in a future PR. If we move the CLI import and export to CONTRIBUTING, then we will want to have a screenshot or description of how to do it from the UI in the README, and the import part is not yet ready.

Let me know if you agree or if I should move import & export in #177 now.

@bzz
Copy link
Contributor

@bzz bzz commented Mar 1, 2018

I'd rather merge #177 as it is, and do

@carlosms sounds good to me

@carlosms carlosms removed their assignment Mar 2, 2018
@bzz
Copy link
Contributor

@bzz bzz commented Mar 2, 2018

Could anybody give me a reason why do we need CLI for import/export?

@smacker In my option, it's just because

  • we already have it, and
  • that might be useful in case someone would need to use this application on their own deployment environemtn
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.