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

Updated frontend documentation to include "Preparing the system for an event" section #52

Merged
merged 11 commits into from Jan 1, 2014

Conversation

Projects
None yet
2 participants
@luke-john
Copy link
Contributor

commented Dec 16, 2013

Added a section to website/README.md titled "Preparing the system for an event" with information on what files need to be updated to get the system prepared for a new event.

Issue #51

@@ -75,6 +75,34 @@ Note: DO NOT run ``make serve`` as root. If you do, virtualenv folders won't
have write permissions, so the tracker won't be able to write to sqlite
database.

Preparing the system for an event

This comment has been minimized.

Copy link
@mithro

mithro Dec 16, 2013

Member

This is actually more "setting up a new instance of the system"


Copy config.private.json.example to config.private.json.

```

This comment has been minimized.

Copy link
@mithro

mithro Dec 16, 2013

Member

Probably, want

```bash
You will then need to update the following files;

* streaming-system/config.private.json
* Update the default object with the event details (where it says timvideos you will need to add your events id.

This comment has been minimized.

Copy link
@mithro

mithro Dec 16, 2013

Member

Missing end bracket.

* Update the default object with the event details (where it says timvideos you will need to add your events id.
* The parent object should have a child object for each room with the room_id matching the event feeds (used by eventfeed2internal.py) room_ids
* streaming-system/website/Makefile#L53
* You may need to update the name of eventfeed2internal.py if you are creating a new parser.

This comment has been minimized.

Copy link
@mithro

mithro Dec 16, 2013

Member

Don't understand this statement?

This comment has been minimized.

Copy link
@luke-john

luke-john Dec 16, 2013

Author Contributor

So currently https://github.com/timvideos/streaming-system/blob/master/website/Makefile#L53 uses pycon2internal.py.

        $(ACTIVATE) && python pycon2internal.py > frontend/data.py

if your creating a new script per event (which sounds likely based on the past) this line would need to be updated every event. Perhaps it would make sense to have an eventfeed2internal.py.example that gets copied to eventfeed2internal.py

* streaming-system/website/frontend/eventfeed2internal.py
* This should generate a output that resembles https://gist.github.com/lukejohnosmahi/7938504
* streaming-system/tools/register/fake_register.py#L26
* Update this once you have connected the events scdedule url with a room id

This comment has been minimized.

Copy link
@mithro

mithro Dec 16, 2013

Member

This shouldn't need to be updated anymore (as it should be using the values inside config.json)

This comment has been minimized.

Copy link
@luke-john

luke-john Dec 16, 2013

Author Contributor

Makes sense, but it means config.json needs either av or fake_register needs to use default, see #50 (comment) for further comment

@luke-john

This comment has been minimized.

Copy link
Contributor Author

commented Dec 18, 2013

ignore this, i mistook a reference that was saying merged for a commit

it looks like the older pull request which was missing the end bracket, had a misleading title and outdated documentation on fake_register.py got pulled instead of the latest version.

mithro added a commit that referenced this pull request Jan 1, 2014

Merge pull request #52 from lukejohnosmahi/update/master/documentation
Updated frontend documentation to include "Preparing the system for an event" section

@mithro mithro merged commit e647117 into timvideos:master Jan 1, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.