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

simplifying installation, documentation and npm update #374

Closed
wants to merge 1 commit into from
Closed

simplifying installation, documentation and npm update #374

wants to merge 1 commit into from

Conversation

vinyll
Copy link
Member

@vinyll vinyll commented Mar 7, 2016

Step 1 of simplifying the installation:

  • updated readme installation
  • moved readme rst to md (planning to move the entire doc to md)
  • moved inv assets tasks to npm (inv assets and inv watch to npm run assets:build and npm run assets:watch) while preserving inv aliases.
  • updated npm babel dependencies to fixed latest
  • fixed a broken div in udata/templates/header.html

This was successfully tested on a brand new VirtualBox'ed Xubuntu 15.10 desktop

@vinyll vinyll self-assigned this Mar 7, 2016
[![JavaScript Dependencies Status](https://david-dm.org/etalab/udata.svg)](https://david-dm.org/etalab/udata)
[![Join the chat at https://gitter.im/etalab/udata](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/etalab/udata?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

uData is an open and social data hub. This currently a work in progress and API is subject to change until the first official release.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we should update that? @noirbizarre ? (btw, missing is I think)

@davidbgk
Copy link
Member

davidbgk commented Mar 7, 2016

That PR made my day!

@vinyll
Copy link
Member Author

vinyll commented Mar 7, 2016

Glad it made your day, it made my week! 😜


git clone https://github.com/etalab/udata.git

Install your [virtualenv](https://virtualenv.readthedocs.org/en/latest/)
Copy link
Member

Choose a reason for hiding this comment

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

Is that really required if all we do is launching the docker-compose command? (Really curious because I don't use Docker)

Copy link
Member Author

Choose a reason for hiding this comment

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

docker-compose will take care of elasticsearch, redis and mongodb. It does not bundle the python project itself.

Copy link
Contributor

Choose a reason for hiding this comment

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

It depends on if we use docker-compose for the stack services only (Mongo, Elasticsearch, Redis...) or the development environment too. Right now, we are using docker-compose only for services, not the complete environment. (sorry, my page was not refreshed. I haven't seen your comment @vinyll )

@vinyll
Copy link
Member Author

vinyll commented Mar 8, 2016

The test broke because of readme.rst -> readme.md which was parsed for setup.py long-description.
I refactored setup.py accordingly

@@ -70,7 +62,7 @@ def dependency_links(filename):
name='udata',
version=__import__('udata').__version__,
description=__import__('udata').__description__,
long_description=long_description,
long_description=clean_doc('README.md'),
Copy link
Contributor

Choose a reason for hiding this comment

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

The main problem is that long_description expected some restructuredtext :/

@noirbizarre noirbizarre mentioned this pull request Mar 14, 2016
@vinyll vinyll closed this May 3, 2016
@vinyll vinyll removed their assignment May 17, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants