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 documentation for realtime #217

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Updated documentation for realtime #217

wants to merge 4 commits into from

Conversation

timlinux
Copy link
Contributor

@akbargumbira can you review please?

@timlinux
Copy link
Contributor Author

See also PR #217

@timlinux
Copy link
Contributor Author

I'm assigning this for Akbar to review. @akbargumbira please let me know if you think anything is missing otherwise let me know if you are happy and I will close out this issue.

@@ -87,188 +88,265 @@ used for much of the data processing and reporting functionality.
.. note:: Currently version 779e16603ee3fb8781c85a0e95913a1f6bbd2d6a is
Copy link
Member

Choose a reason for hiding this comment

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

this is not valid anymore

@akbargumbira
Copy link
Member

@timlinux: In the architecture section, could you update to the current architecture? Some of them are not valid anymore and there are some invalid placement of syntax I guess so it looks like
screenshot from 2014-08-18 14 41 32 (look at the explanation of shake_event and make_map)


At this point you should enter ‘yes’ when prompted
::
There are 4 docker images used for deployment
Copy link
Member

Choose a reason for hiding this comment

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

add a colon would be nice

@akbargumbira
Copy link
Member

and this is also rendered like this (I expect it should not include quote):
screenshot from 2014-08-18 14 59 28

@akbargumbira
Copy link
Member

I also added 'software-tag' for replaceable keywords

@akbargumbira
Copy link
Member

About Customising The Template section, we set the template path on docker run inasafe (./run.sh), so we should update it

@akbargumbira
Copy link
Member

Overall:

  • In the Installation Overview, I think we should add a diagram that contains 4 those docker and the host and the default port mapping between those 4 docker and the host. Also, how to configure those ports.
  • We should tell the user how to use non-default working dir (which is now to /home/realtime/) - basically telling them to change function.sh
  • We should tell the user what's in the btsync and how the user can configure the data related to customing things (related to the section: customising the template, QGIS realtime project, configuration of population data)
  • Update the section Running a shake event, as for now we can only run the latest shakemap using ./run.sh from the host, unless we tell that those command needs to be run on inasafe-realtime container.
  • About the section Unit Test and Batch Validation and Running, I am not sure if this is still valid

@mach0
Copy link
Contributor

mach0 commented Oct 10, 2014

@akbargumbira is this now ready to be merged?

@akbargumbira
Copy link
Member

No, I guess @timlinux is going to address my comments first?
On Oct 10, 2014 10:33 PM, "Werner Macho" [email protected] wrote:

@akbargumbira https://github.com/akbargumbira is this now ready to be
merged?


Reply to this email directly or view it on GitHub
#217 (comment).

@akbargumbira
Copy link
Member

Hi @timlinux, can I remind you for this? On tuesday, I will deploy realtime on BNPB and they ask a guideline and manual. Thanks

@mach0
Copy link
Contributor

mach0 commented Jan 7, 2015

@akbargumbira @timlinux just want to push this again as it is the last pull request in line ..

@mach0
Copy link
Contributor

mach0 commented Mar 24, 2015

is this now ready to be (manually) merged?

@timlinux
Copy link
Contributor Author

Hi Werner

A lot changed since I wrote that patch, so I need to review it again. I think I won't get to it this week though.

Regards

Tim

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.

3 participants