[IGBF-2243] Deploy Genoviz SDK Javadocs on Bioviz - JIRA UNCC

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:
Improve IGB for developers
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

Options
- Sort By Name
- Sort By Date
- Ascending
- Descending
- Thumbnails
- List
- Download All

Attachments

javadoc.sh
0.3 kB
01/Apr/20 11:38 AM

Issue Links

relates to

IGBF-2228 Build javadocs for Genoviz SDK and copy compiled javadocs to Downloads

Closed

Activity

Ascending order - Click to sort in descending order

Ann Loraine created issue - 31/Jan/20 3:42 PM

Ann Loraine made changes - 31/Jan/20 3:42 PM

Field	Original Value	New Value
Epic Link		IGBF-1531 [ 17617 ]

Ann Loraine made changes - 31/Jan/20 3:42 PM

Link

This issue relates to ~~IGBF-2228~~ [ ~~IGBF-2228~~ ]

Ann Loraine made changes - 31/Jan/20 3:42 PM

Rank

Ranked higher

Ann Loraine made changes - 31/Jan/20 3:45 PM

Assignee

Ann Loraine [ aloraine ]

Ann Loraine made changes - 18/Feb/20 7:00 AM

Sprint

Spring 3 : 3 Feb to 14 Feb [ 86 ]

Spring 3 : 3 Feb to 14 Feb, Spring 3 : 17 Feb to 21 Feb [ 86, 87 ]

Ann Loraine made changes - 18/Feb/20 7:00 AM

Rank

Ranked higher

Nowlan Freese made changes - 03/Mar/20 10:29 AM

Sprint

Spring 3 : 3 Feb to 14 Feb, Spring 3 : 17 Feb to 28 Feb [ 86, 87 ]

Spring 3 : 3 Feb to 14 Feb, Spring 3 : 17 Feb to 28 Feb, Spring 4 : 2 Mar to 13 Mar [ 86, 87, 89 ]

Nowlan Freese made changes - 03/Mar/20 10:29 AM

Rank

Ranked higher

Nowlan Freese made changes - 16/Mar/20 11:35 AM

Sprint

Spring 3 : 3 Feb to 14 Feb, Spring 3 : 17 Feb to 28 Feb, Spring 4 : 2 Mar to 13 Mar [ 86, 87, 89 ]

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 [ 86, 87, 89, 90 ]

Nowlan Freese made changes - 16/Mar/20 11:36 AM

Rank

Ranked higher

Noor Zahara (Inactive) made changes - 25/Mar/20 12:11 PM

Assignee

Noor Zahara [ noor91zahara ]

Noor Zahara (Inactive) made changes - 25/Mar/20 1:13 PM

Status

To-Do [ 10305 ]

In Progress [ 3 ]

Hide

Permalink

Noor Zahara (Inactive) added a comment - 25/Mar/20 2:10 PM

Ann Loraine

Should I link the menu to 'http://bitbucket.org/lorainelab/genoviz-sdk/downloads/genoviz-1.1.8-javadoc.jar' ?

Show

Noor Zahara (Inactive) added a comment - 25/Mar/20 2:10 PM Ann Loraine Should I link the menu to 'http://bitbucket.org/lorainelab/genoviz-sdk/downloads/genoviz-1.1.8-javadoc.jar' ?

Nowlan Freese made changes - 30/Mar/20 8:51 AM

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 [ 86, 87, 89, 90 ]

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 [ 86, 87, 89, 90, 91 ]

Nowlan Freese made changes - 30/Mar/20 8:51 AM

Rank

Ranked higher

Noor Zahara (Inactive) made changes - 01/Apr/20 11:38 AM

Attachment

javadoc.sh [ 14688 ]

Hide

Permalink

Noor Zahara (Inactive) added a comment - 01/Apr/20 11:39 AM

Ann Loraine - I have attached the script file. Kindly let me know if it is fine.

Show

Noor Zahara (Inactive) added a comment - 01/Apr/20 11:39 AM Ann Loraine - I have attached the script file. Kindly let me know if it is fine.

Hide

Permalink

Noor Zahara (Inactive) added a comment - 01/Apr/20 1:10 PM

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.

Show

Noor Zahara (Inactive) added a comment - 01/Apr/20 1:10 PM 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.

Noor Zahara (Inactive) made changes - 01/Apr/20 1:10 PM

Status

In Progress [ 3 ]

Needs 1st Level Review [ 10005 ]

Noor Zahara (Inactive) made changes - 01/Apr/20 1:10 PM

Assignee

Noor Zahara [ noor91zahara ]

Ann Loraine made changes - 13/Apr/20 7:47 PM

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 [ 86, 87, 89, 90, 91 ]

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 [ 86, 87, 89, 90, 91, 92 ]

Ann Loraine made changes - 13/Apr/20 7:48 PM

Rank

Ranked higher

Ann Loraine made changes - 15/Apr/20 12:33 PM

Status

Needs 1st Level Review [ 10005 ]

First Level Review in Progress [ 10301 ]

Ann Loraine made changes - 15/Apr/20 12:33 PM

Status

First Level Review in Progress [ 10301 ]

To-Do [ 10305 ]

Ann Loraine made changes - 15/Apr/20 12:33 PM

Assignee

Noor Zahara [ noor91zahara ]

Hide

Permalink

Ann Loraine added a comment - 15/Apr/20 12:33 PM

Please see comments on the committed files for above branch.
cc: Noor Zahara

Show

Ann Loraine added a comment - 15/Apr/20 12:33 PM Please see comments on the committed files for above branch. cc: Noor Zahara

Hide

Permalink

Noor Zahara (Inactive) added a comment - 15/Apr/20 1:57 PM

I have made changes as per the comments

https://bitbucket.org/noorzahara/bioviz-local/branch/IGBF-2243#diff

Show

Noor Zahara (Inactive) added a comment - 15/Apr/20 1:57 PM I have made changes as per the comments https://bitbucket.org/noorzahara/bioviz-local/branch/IGBF-2243#diff

Noor Zahara (Inactive) made changes - 15/Apr/20 1:57 PM

Status

To-Do [ 10305 ]

In Progress [ 3 ]

Noor Zahara (Inactive) made changes - 15/Apr/20 1:57 PM

Status

In Progress [ 3 ]

Needs 1st Level Review [ 10005 ]

Noor Zahara (Inactive) made changes - 15/Apr/20 1:57 PM

Assignee

Noor Zahara [ noor91zahara ]

Hide

Permalink

Ann Loraine added a comment - 15/Apr/20 2:13 PM

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.

Show

Ann Loraine added a comment - 15/Apr/20 2:13 PM 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.

Ann Loraine made changes - 15/Apr/20 2:13 PM

Status

Needs 1st Level Review [ 10005 ]

First Level Review in Progress [ 10301 ]

Ann Loraine made changes - 15/Apr/20 2:13 PM

Status

First Level Review in Progress [ 10301 ]

Ready for Pull Request [ 10304 ]

Hide

Permalink

Ann Loraine added a comment - 15/Apr/20 2:14 PM

Please squash commits and submit a PR.

Show

Ann Loraine added a comment - 15/Apr/20 2:14 PM Please squash commits and submit a PR.

Ann Loraine made changes - 15/Apr/20 2:14 PM

Assignee

Noor Zahara [ noor91zahara ]

Hide

Permalink

Noor Zahara (Inactive) added a comment - 15/Apr/20 2:34 PM

I squashed the changes and created a PR

https://bitbucket.org/lorainelab/bioviz/pull-requests/38/igbf-2243-deploy-genoviz-sdk-javadocs-on/diff

Show

Noor Zahara (Inactive) added a comment - 15/Apr/20 2:34 PM I squashed the changes and created a PR https://bitbucket.org/lorainelab/bioviz/pull-requests/38/igbf-2243-deploy-genoviz-sdk-javadocs-on/diff

Noor Zahara (Inactive) made changes - 15/Apr/20 2:34 PM

Status

Ready for Pull Request [ 10304 ]

Pull Request Submitted [ 10101 ]

Noor Zahara (Inactive) made changes - 15/Apr/20 2:34 PM

Assignee

Noor Zahara [ noor91zahara ]

Ann Loraine made changes - 16/Apr/20 5:43 AM

Status

Pull Request Submitted [ 10101 ]

Reviewing Pull Request [ 10303 ]

Ann Loraine made changes - 16/Apr/20 5:43 AM

Status

Reviewing Pull Request [ 10303 ]

Merged Needs Testing [ 10002 ]

Hide

Permalink

Ann Loraine added a comment - 16/Apr/20 5:44 AM

To test:

Deploy bioviz site on an EC2
Run the script
Check that the javadocs can be navigated

Show

Ann Loraine added a comment - 16/Apr/20 5:44 AM To test: Deploy bioviz site on an EC2 Run the script Check that the javadocs can be navigated

Hide

Permalink

Ann Loraine added a comment - 24/Apr/20 1:34 AM

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.

Show

Ann Loraine added a comment - 24/Apr/20 1:34 AM 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.

Ann Loraine made changes - 24/Apr/20 1:34 AM

Status

Merged Needs Testing [ 10002 ]

Post-merge Testing In Progress [ 10003 ]

Ann Loraine made changes - 24/Apr/20 1:34 AM

Status

Post-merge Testing In Progress [ 10003 ]

To-Do [ 10305 ]

Ann Loraine made changes - 24/Apr/20 1:34 AM

Assignee

Noor Zahara [ noor91zahara ]

Hide

Permalink

Noor Zahara (Inactive) added a comment - 24/Apr/20 1:56 PM - edited

Ann Loraine - 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.

Show

Noor Zahara (Inactive) added a comment - 24/Apr/20 1:56 PM - edited Ann Loraine - 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.

Ann Loraine made changes - 24/Apr/20 10:11 PM

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 [ 86, 87, 89, 90, 91, 92 ]

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 [ 86, 87, 89, 90, 91, 92, 93 ]

Ann Loraine made changes - 24/Apr/20 10:11 PM

Rank

Ranked higher

Hide

Permalink

Ann Loraine added a comment - 25/Apr/20 8:47 PM

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.

Show

Ann Loraine added a comment - 25/Apr/20 8:47 PM 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.