Details
-
Type:
Task
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:0.25
-
Epic Link:
-
Sprint:Spring 3 : 3 Feb to 14 Feb, Spring 3 : 17 Feb to 28 Feb, Spring 4 : 2 Mar to 13 Mar, Spring 5 : 16 Mar to 27 Mar, Spring 6 : 30 Mar to Apr 10, Spring 7 : 13 Apr to 24 Apr, Spring 8 : 24 Apr to 8 May
Description
To help developers understand how to use the Genoviz SDK, we should deploy the javadocs on an easy to reach location.
For this task, add new menu item to BioViz.org under "For Developers" - call it "GenViz SDK Javadocs"
Attachments
Issue Links
- relates to
-
-
- Closed
-
Activity
[~aloraine] - I have attached the script file. Kindly let me know if it is fine.
Code Diff - https://bitbucket.org/noorzahara/bioviz-local/branch/IGBF-2243#diff
Testing Steps -
Run javadoc.sh from within the application
Check if Genoviz SDK Javadocs option is added under "Developers" tab on bioviz application
Click on 'Genoviz SDK Javadocs', a page containing javadoc details should open.
Please see comments on the committed files for above branch.
cc: Noor Zahara
I have made changes as per the comments
https://bitbucket.org/noorzahara/bioviz-local/branch/IGBF-2243#diff
Thanks - this looks fine. I have not tried to run it, but it looks like it should work.
For the next steps, please squash the commits (rebase -i) into one commit and submit a PR.
Please squash commits and submit a PR.
I squashed the changes and created a PR
To test:
- Deploy bioviz site on an EC2
- Run the script
- Check that the javadocs can be navigated
I followed the above steps and observed an error when running the script.
I tested the "tar" command and noticed this error:
AnnBioviz root $ tar xvzf genoviz-1.1.9-javadoc.jar
gzip: stdin has more than one entry--rest ignored
tar: Child returned status 2
tar: Error is not recoverable: exiting now
Returning to To-Do for Noor Zahara to take a look.
[~aloraine] - Could you try the same command without the z i.e tar xvf genoviz-1.1.9-javadoc.jar ?
I have made the changes to the script.
Migrated the command to ansible playbook which will be used to deploy and provision bioviz Web sites.
Also, as part of the provisioning process, added creation of a sub-directory under "releases" named for the version of genoviz.
A symbolic link "current" links to the current release.
Also, changed the link in BioViz hmtl to "current" instead of "releases/index.html".
Moving this to Done.
[~aloraine]
Should I link the menu to 'http://bitbucket.org/lorainelab/genoviz-sdk/downloads/genoviz-1.1.8-javadoc.jar' ?