- Release-team - mailman3.cels.anl.gov

Redeploy request for workspace
by Gavin A Price 15 Jul '14

15 Jul '14

Hi, the workspace team would like a redeploy for the production workspace service. This will move the workspace service from v 0.1.6 to 0.2.1. There are several important bugfixes, as well as much less memory use and about a 50% speed increase (in admittedly somewhat limited tests). v0.2.0 has been available on the dev workspace for a couple months now with only one reported problem. This problem should be fixed in 0.2.1. Also, a couple scripts have been fixed to work properly in IRIS with the new IRIS config mechanism. There's a document with notes about how to upgrade from 0.1.6 to 0.2.0. Upgrading to 0.2.1 requires no special actions: https://docs.google.com/a/lbl.gov/document/d/1zRU7jvXuL01Ru6gUpcGAFYngDGBtG… We would prefer the redeploy to happen this week, prior to the tests next week. Thanks, Gavin, official spokesperson of KBase Workspaces Ltd.

1 0

Re: [Release-team] request to put KB Protein Structure Service
by Sean McCorkle 12 Jul '14

12 Jul '14

Hey you're right - it works from my home. I wasn't able to connect previously (from BNL, same exercise on a different instance, also Havana - same symptoms, localhost:7088 worked fine, internal request to IP hung up, and external from BNL did as well. Its possible I mistyped the address then). Thanks! On Sat, Jul 12, 2014 at 4:48 PM, Murphy-Olson, Daniel E. <dolson(a)mcs.anl.gov> wrote: > The external address seems to work for me from an outside connection. > > ________________________________________ > From: Sean McCorkle [sean.r.mccorkle(a)gmail.com] > Sent: Saturday, July 12, 2014 3:30 PM > To: Brettin, Thomas S. > Cc: release-team(a)kbase.us; Murphy-Olson, Daniel E. > Subject: Re: [Release-team] request to put KB Protein Structure Service > > Okay, done. Its in the repo now. I tried a clean build on a fresh VM > instance (using Havana) and every test checks out,up to the client > -server network connection on port 7088. A connection to > http://localhost:7088 works fine, but not one to the assigned IP > address http://140.221.67.170:7088, and I can't get that to work > externally either. I suspect I'm doing something wrong with the > Havana security group rules or something. (I don't think the issue is > in the service code) > > Thanks again! > =sean > > On Sat, Jul 12, 2014 at 10:49 AM, Sean McCorkle > <sean.r.mccorkle(a)gmail.com> wrote: >> No problem at all to change the name - I'll make the deployment directory >> >> /kb/deployment/services/protein_structure_service >> >> to match the repo name, and I assume the "official" url will have the >> same name as well? >> >> http://kbase.us/services/protein_structure_service >> >> will make the changes, run my checks and then push to git and let you >> know right afterwards. >> >> Thanks! >> >> =sean >> >> >> >> >> >> >> On Sat, Jul 12, 2014 at 9:03 AM, Thomas Brettin <brettin(a)anl.gov> wrote: >>> Hi Sean >>> >>> Usually the deployment directory syntactically the same as the repo name. There are a few deviants from this, and its usually causes a bit of a hassle. Would you mind changing the deployment directory name to the name of the git repo? >>> >>> Tom >>> >>> >>> On Jul 10, 2014, at 9:32 AM, Sean McCorkle <sean.r.mccorkle(a)gmail.com> wrote: >>> >>>> Hello, >>>> >>>> After some vetting by Shinjae last week, and a discussion with Dan >>>> yesterday, I would like to submit the KBase Protein Structure service >>>> that I've been working on as a candidate for production. The repo is >>>> "protein_structure_service" on git.kbase.us, the deployment target >>>> directory is "kbaseproteinstructure". There are two methods and two >>>> associated client scripts which give a est match PDB id given a KBase >>>> protein MD5 or feature id. I've done about as much as I can by way >>>> of documentation and testing. I sincerely hope this won't be a big >>>> hassle for anybody. >>>> >>>> Looking forward to hearing from anybody on this, and thank you for >>>> the consideration! >>>> >>>> -- >>>> >>>> Sean R. McCorkle >>>> sean.r.mccorkle(a)gmail.com >>>> _______________________________________________ >>>> Release-team mailing list >>>> Release-team(a)lists.kbase.us >>>> https://lists.kbase.us/mailman/listinfo/release-team >>> >> >> >> >> -- >> >> Sean R. McCorkle >> sean.r.mccorkle(a)gmail.com > > > > -- > > Sean R. McCorkle > sean.r.mccorkle(a)gmail.com -- Sean R. McCorkle sean.r.mccorkle(a)gmail.com

1 0

Re: [Release-team] request to put KB Protein Structure Service
by Murphy-Olson, Daniel E. 12 Jul '14

12 Jul '14

The external address seems to work for me from an outside connection. ________________________________________ From: Sean McCorkle [sean.r.mccorkle(a)gmail.com] Sent: Saturday, July 12, 2014 3:30 PM To: Brettin, Thomas S. Cc: release-team(a)kbase.us; Murphy-Olson, Daniel E. Subject: Re: [Release-team] request to put KB Protein Structure Service Okay, done. Its in the repo now. I tried a clean build on a fresh VM instance (using Havana) and every test checks out,up to the client -server network connection on port 7088. A connection to http://localhost:7088 works fine, but not one to the assigned IP address http://140.221.67.170:7088, and I can't get that to work externally either. I suspect I'm doing something wrong with the Havana security group rules or something. (I don't think the issue is in the service code) Thanks again! =sean On Sat, Jul 12, 2014 at 10:49 AM, Sean McCorkle <sean.r.mccorkle(a)gmail.com> wrote: > No problem at all to change the name - I'll make the deployment directory > > /kb/deployment/services/protein_structure_service > > to match the repo name, and I assume the "official" url will have the > same name as well? > > http://kbase.us/services/protein_structure_service > > will make the changes, run my checks and then push to git and let you > know right afterwards. > > Thanks! > > =sean > > > > > > > On Sat, Jul 12, 2014 at 9:03 AM, Thomas Brettin <brettin(a)anl.gov> wrote: >> Hi Sean >> >> Usually the deployment directory syntactically the same as the repo name. There are a few deviants from this, and its usually causes a bit of a hassle. Would you mind changing the deployment directory name to the name of the git repo? >> >> Tom >> >> >> On Jul 10, 2014, at 9:32 AM, Sean McCorkle <sean.r.mccorkle(a)gmail.com> wrote: >> >>> Hello, >>> >>> After some vetting by Shinjae last week, and a discussion with Dan >>> yesterday, I would like to submit the KBase Protein Structure service >>> that I've been working on as a candidate for production. The repo is >>> "protein_structure_service" on git.kbase.us, the deployment target >>> directory is "kbaseproteinstructure". There are two methods and two >>> associated client scripts which give a est match PDB id given a KBase >>> protein MD5 or feature id. I've done about as much as I can by way >>> of documentation and testing. I sincerely hope this won't be a big >>> hassle for anybody. >>> >>> Looking forward to hearing from anybody on this, and thank you for >>> the consideration! >>> >>> -- >>> >>> Sean R. McCorkle >>> sean.r.mccorkle(a)gmail.com >>> _______________________________________________ >>> Release-team mailing list >>> Release-team(a)lists.kbase.us >>> https://lists.kbase.us/mailman/listinfo/release-team >> > > > > -- > > Sean R. McCorkle > sean.r.mccorkle(a)gmail.com -- Sean R. McCorkle sean.r.mccorkle(a)gmail.com

1 0

Re: [Release-team] request to put KB Protein Structure Service
by Sean McCorkle 12 Jul '14

12 Jul '14

Okay, done. Its in the repo now. I tried a clean build on a fresh VM instance (using Havana) and every test checks out,up to the client -server network connection on port 7088. A connection to http://localhost:7088 works fine, but not one to the assigned IP address http://140.221.67.170:7088, and I can't get that to work externally either. I suspect I'm doing something wrong with the Havana security group rules or something. (I don't think the issue is in the service code) Thanks again! =sean On Sat, Jul 12, 2014 at 10:49 AM, Sean McCorkle <sean.r.mccorkle(a)gmail.com> wrote: > No problem at all to change the name - I'll make the deployment directory > > /kb/deployment/services/protein_structure_service > > to match the repo name, and I assume the "official" url will have the > same name as well? > > http://kbase.us/services/protein_structure_service > > will make the changes, run my checks and then push to git and let you > know right afterwards. > > Thanks! > > =sean > > > > > > > On Sat, Jul 12, 2014 at 9:03 AM, Thomas Brettin <brettin(a)anl.gov> wrote: >> Hi Sean >> >> Usually the deployment directory syntactically the same as the repo name. There are a few deviants from this, and its usually causes a bit of a hassle. Would you mind changing the deployment directory name to the name of the git repo? >> >> Tom >> >> >> On Jul 10, 2014, at 9:32 AM, Sean McCorkle <sean.r.mccorkle(a)gmail.com> wrote: >> >>> Hello, >>> >>> After some vetting by Shinjae last week, and a discussion with Dan >>> yesterday, I would like to submit the KBase Protein Structure service >>> that I've been working on as a candidate for production. The repo is >>> "protein_structure_service" on git.kbase.us, the deployment target >>> directory is "kbaseproteinstructure". There are two methods and two >>> associated client scripts which give a est match PDB id given a KBase >>> protein MD5 or feature id. I've done about as much as I can by way >>> of documentation and testing. I sincerely hope this won't be a big >>> hassle for anybody. >>> >>> Looking forward to hearing from anybody on this, and thank you for >>> the consideration! >>> >>> -- >>> >>> Sean R. McCorkle >>> sean.r.mccorkle(a)gmail.com >>> _______________________________________________ >>> Release-team mailing list >>> Release-team(a)lists.kbase.us >>> https://lists.kbase.us/mailman/listinfo/release-team >> > > > > -- > > Sean R. McCorkle > sean.r.mccorkle(a)gmail.com -- Sean R. McCorkle sean.r.mccorkle(a)gmail.com

1 0

Re: [Release-team] request to put KB Protein Structure Service
by Sean McCorkle 12 Jul '14

12 Jul '14

No problem at all to change the name - I'll make the deployment directory /kb/deployment/services/protein_structure_service to match the repo name, and I assume the "official" url will have the same name as well? http://kbase.us/services/protein_structure_service will make the changes, run my checks and then push to git and let you know right afterwards. Thanks! =sean On Sat, Jul 12, 2014 at 9:03 AM, Thomas Brettin <brettin(a)anl.gov> wrote: > Hi Sean > > Usually the deployment directory syntactically the same as the repo name. There are a few deviants from this, and its usually causes a bit of a hassle. Would you mind changing the deployment directory name to the name of the git repo? > > Tom > > > On Jul 10, 2014, at 9:32 AM, Sean McCorkle <sean.r.mccorkle(a)gmail.com> wrote: > >> Hello, >> >> After some vetting by Shinjae last week, and a discussion with Dan >> yesterday, I would like to submit the KBase Protein Structure service >> that I've been working on as a candidate for production. The repo is >> "protein_structure_service" on git.kbase.us, the deployment target >> directory is "kbaseproteinstructure". There are two methods and two >> associated client scripts which give a est match PDB id given a KBase >> protein MD5 or feature id. I've done about as much as I can by way >> of documentation and testing. I sincerely hope this won't be a big >> hassle for anybody. >> >> Looking forward to hearing from anybody on this, and thank you for >> the consideration! >> >> -- >> >> Sean R. McCorkle >> sean.r.mccorkle(a)gmail.com >> _______________________________________________ >> Release-team mailing list >> Release-team(a)lists.kbase.us >> https://lists.kbase.us/mailman/listinfo/release-team > -- Sean R. McCorkle sean.r.mccorkle(a)gmail.com

1 0

Re: [Release-team] request to put KB Protein Structure Service
by Thomas Brettin 12 Jul '14

12 Jul '14

Hi Sean Usually the deployment directory syntactically the same as the repo name. There are a few deviants from this, and its usually causes a bit of a hassle. Would you mind changing the deployment directory name to the name of the git repo? Tom On Jul 10, 2014, at 9:32 AM, Sean McCorkle <sean.r.mccorkle(a)gmail.com> wrote: > Hello, > > After some vetting by Shinjae last week, and a discussion with Dan > yesterday, I would like to submit the KBase Protein Structure service > that I've been working on as a candidate for production. The repo is > "protein_structure_service" on git.kbase.us, the deployment target > directory is "kbaseproteinstructure". There are two methods and two > associated client scripts which give a est match PDB id given a KBase > protein MD5 or feature id. I've done about as much as I can by way > of documentation and testing. I sincerely hope this won't be a big > hassle for anybody. > > Looking forward to hearing from anybody on this, and thank you for > the consideration! > > -- > > Sean R. McCorkle > sean.r.mccorkle(a)gmail.com > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us > https://lists.kbase.us/mailman/listinfo/release-team

1 0

request to put KB Protein Structure Service
by Sean McCorkle 09 Jul '14

09 Jul '14

Hello, After some vetting by Shinjae last week, and a discussion with Dan yesterday, I would like to submit the KBase Protein Structure service that I've been working on as a candidate for production. The repo is "protein_structure_service" on git.kbase.us, the deployment target directory is "kbaseproteinstructure". There are two methods and two associated client scripts which give a est match PDB id given a KBase protein MD5 or feature id. I've done about as much as I can by way of documentation and testing. I sincerely hope this won't be a big hassle for anybody. Looking forward to hearing from anybody on this, and thank you for the consideration! -- Sean R. McCorkle sean.r.mccorkle(a)gmail.com

1 0

Re: [Release-team] Need API doc updated for workspace
by Erik Pearson 03 Jul '14

03 Jul '14

Dan, Or perhaps we should just make “Perl API” and “Java API” links directly in the Workspace section of the services page? http://kbase.us/developer_zone/services Erik. On Jul 3, 2014, at 10:39 AM, Murphy-Olson, Daniel E. <dolson(a)mcs.anl.gov> wrote: > Erik, > > The java docs are available at http://kbase.us/services/docs/workspace/javadoc/. Maybe we can link to this in the sidebar? > > Dan > ________________________________________ > From: release-team-bounces(a)lists.kbase.us [release-team-bounces(a)lists.kbase.us] on behalf of Erik Pearson [eapearson(a)lbl.gov] > Sent: Thursday, July 03, 2014 12:36 PM > To: release-team(a)lists.kbase.us > Subject: Re: [Release-team] Need API doc updated for workspace > > The workspace docs (Perl API, Release Notes) have been updated on the site to release 0.1.6 of workspace_deluxe. In the docs repo they live in workspace_deluxe, and the (internal include) links now reflect this. This was done from outside the workspace_deluxe repo without touching it other than checking out to 0.1.6. For Java API, command line docs, and maybe other stuff, I would need to build workspace in a dev-container, something I’m not yet familiar with. > > Erik. > > On Jul 2, 2014, at 2:18 PM, Nomi Harris <nlharris(a)lbl.gov> wrote: > >> Thanks, Erik. >> >> I discussed this issue (updating the API docs when needed) with Erik. In the longer term, he will look into automating this. In the short term, he just needs to know when a service has been (re)deployed so he can update the API doc for it. He and I couldn’t think of any way he would know this unless Dan tells him, but if there’s some way he could be automatically informed, please let us know! >> >> Nomi >> >> On Jul 2, 2014, at 12:42 PM, Erik Pearson <eapearson(a)lbl.gov> wrote: >> >>> Okay, so I can either build the docs from the workspace_deluxe repo 0.1.6 release or someone can just send me or point me to the location of the build/deployed docs, in either case I’ll take care of incorporating the workspace docs into the docs repo. >>> >>> Erik. >>> >>> >>> On Jul 2, 2014, at 12:05 PM, Erik Pearson <eapearson(a)lbl.gov> wrote: >>> >>>> On Jul 2, 2014, at 11:46 AM, Nomi Harris <nlharris(a)lbl.gov> wrote: >>>> >>>>> Dear Release Team, >>>>> Gavin informed me that the API doc at http://kbase.us/developer-zone/documentation/workspace-service/ is out of date—it should have been updated when the newer version of the workspace service was deployed to production. >>>>> >>>>> What is the current situation with the updating of these API docs—does it require a human to copy them somewhere, or should that happen automatically when a service is deployed to production? >>>> >>>> This specific doc needs to appear in the docs repo as workspace_service/workspaceService.html. >>>> >>>> There is a magic script which which will separate the navigation and the document body and store them in separate files, which are then included directly into the web page (yes, as includes, so whenever the files change the doc web page just shows the new files.) >>>> >>>> There is a manual step for the API doc — I will notice the commit to the docs repo and do the work. Release notes will be automatically updated since they are read straight from the repo. There is also a related “Command Line Help” document located at docs/command_line_prod/Workspace_Service_CommandLineHelp.txt and will be updated on the site automatically (it is shown simply as a plain text page). >>>> >>>> We have plans to for a documentation build process including detection of changes to source docs. >>>> >>>> Erik. >>>> >>>>> >>>>> Also, please add Erik to the release-team mailing list. He is handling the web-facing part (adding the kbase “style” to the API docs). >>>>> >>>>> Thanks, >>>>> Nomi >>>>> >>>>> Begin forwarded message: >>>>> >>>>>> From: Christopher Henry <chrisshenry(a)gmail.com> >>>>>> Subject: Re: workspace docs on website out of date >>>>>> Date: July 2, 2014 at 11:39:23 AM PDT >>>>>> To: Nomi Harris <nlharris(a)lbl.gov> >>>>>> Cc: Gavin A Price <gavinaprice(a)gmail.com> >>>>>> >>>>>> Yes! >>>>>> >>>>>> On Jul 2, 2014, at 1:36 PM, Nomi Harris <nlharris(a)lbl.gov> wrote: >>>>>> >>>>>>> Ok, so you’re saying the API doc at http://kbase.us/developer-zone/documentation/workspace-service/ already should have been updated to 0.1.6? >>>>>>> >>>>>>> On Jul 2, 2014, at 11:34 AM, Gavin A Price <gavinaprice(a)gmail.com> wrote: >>>>>>> >>>>>>>> production has been running 0.1.6 for months. >>>>>>>> >>>>>>>> production is *also* running 0.0.5 but no one should be using that other than Chris for data transfer and job handling purposes. >>>>>>>> >>>>>>>> -g >>>>>>>> >>>>>>>> On 7/2/2014 11:24 AM, Nomi Harris wrote: >>>>>>>>> When the production version updates to 0.1.6 then the API doc should get updated during the deploy process. >>>>>>>>> >>>>>>>>> On Jun 26, 2014, at 4:45 PM, Gavin A Price<gavinaprice(a)gmail.com> wrote: >>>>>>>>> >>>>>>>>>> It's probably because 0.0.5 is still running in production at the workspace and workspace_service endpoints (I think those are right) because the data transfer is still ongoing and FBA still uses the workspace as a job runner. >>>>>>>>>> >>>>>>>>>> 0.1.6 is also running at the ws endpoint, but that's the version everyone should be using at this point. >>>>>>>>>> >>>>>>>>>> -g >>>>>>>>>> >>>>>>>>>> On 6/26/2014 4:39 PM, Nomi Harris wrote: >>>>>>>>>>> When a service is (re)deployed into production, its API doc is supposed to get pushed as well. I’m not sure why that didn’t happen in this case. I will investigate. >>>>>>>>>>> >>>>>>>>>>> On Jun 26, 2014, at 4:37 PM, Gavin A Price<gavinaprice(a)gmail.com> wrote: >>>>>>>>>>> >>>>>>>>>>>> It's been brought to my attention that we're still on version 0.0.5 of the workspace docs here: http://kbase.us/developer-zone/documentation/workspace-service/ >>>>>>>>>>>> >>>>>>>>>>>> Should we update to the 0.1.6 docs, which is currently in production? If so, Nomi, could you explain the process? >>>>>>>>>>>> >>>>>>>>>>>> Thanks, Gavin >>>>>>>>> >>> >>> _______________________________________________ >>> Release-team mailing list >>> Release-team(a)lists.kbase.us >>> https://lists.kbase.us/mailman/listinfo/release-team >> >> _______________________________________________ >> Release-team mailing list >> Release-team(a)lists.kbase.us >> https://lists.kbase.us/mailman/listinfo/release-team > > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us > https://lists.kbase.us/mailman/listinfo/release-team

1 0

Re: [Release-team] Need API doc updated for workspace
by Murphy-Olson, Daniel E. 03 Jul '14

03 Jul '14

Erik, The java docs are available at http://kbase.us/services/docs/workspace/javadoc/. Maybe we can link to this in the sidebar? Dan ________________________________________ From: release-team-bounces(a)lists.kbase.us [release-team-bounces(a)lists.kbase.us] on behalf of Erik Pearson [eapearson(a)lbl.gov] Sent: Thursday, July 03, 2014 12:36 PM To: release-team(a)lists.kbase.us Subject: Re: [Release-team] Need API doc updated for workspace The workspace docs (Perl API, Release Notes) have been updated on the site to release 0.1.6 of workspace_deluxe. In the docs repo they live in workspace_deluxe, and the (internal include) links now reflect this. This was done from outside the workspace_deluxe repo without touching it other than checking out to 0.1.6. For Java API, command line docs, and maybe other stuff, I would need to build workspace in a dev-container, something I’m not yet familiar with. Erik. On Jul 2, 2014, at 2:18 PM, Nomi Harris <nlharris(a)lbl.gov> wrote: > Thanks, Erik. > > I discussed this issue (updating the API docs when needed) with Erik. In the longer term, he will look into automating this. In the short term, he just needs to know when a service has been (re)deployed so he can update the API doc for it. He and I couldn’t think of any way he would know this unless Dan tells him, but if there’s some way he could be automatically informed, please let us know! > > Nomi > > On Jul 2, 2014, at 12:42 PM, Erik Pearson <eapearson(a)lbl.gov> wrote: > >> Okay, so I can either build the docs from the workspace_deluxe repo 0.1.6 release or someone can just send me or point me to the location of the build/deployed docs, in either case I’ll take care of incorporating the workspace docs into the docs repo. >> >> Erik. >> >> >> On Jul 2, 2014, at 12:05 PM, Erik Pearson <eapearson(a)lbl.gov> wrote: >> >>> On Jul 2, 2014, at 11:46 AM, Nomi Harris <nlharris(a)lbl.gov> wrote: >>> >>>> Dear Release Team, >>>> Gavin informed me that the API doc at http://kbase.us/developer-zone/documentation/workspace-service/ is out of date—it should have been updated when the newer version of the workspace service was deployed to production. >>>> >>>> What is the current situation with the updating of these API docs—does it require a human to copy them somewhere, or should that happen automatically when a service is deployed to production? >>> >>> This specific doc needs to appear in the docs repo as workspace_service/workspaceService.html. >>> >>> There is a magic script which which will separate the navigation and the document body and store them in separate files, which are then included directly into the web page (yes, as includes, so whenever the files change the doc web page just shows the new files.) >>> >>> There is a manual step for the API doc — I will notice the commit to the docs repo and do the work. Release notes will be automatically updated since they are read straight from the repo. There is also a related “Command Line Help” document located at docs/command_line_prod/Workspace_Service_CommandLineHelp.txt and will be updated on the site automatically (it is shown simply as a plain text page). >>> >>> We have plans to for a documentation build process including detection of changes to source docs. >>> >>> Erik. >>> >>>> >>>> Also, please add Erik to the release-team mailing list. He is handling the web-facing part (adding the kbase “style” to the API docs). >>>> >>>> Thanks, >>>> Nomi >>>> >>>> Begin forwarded message: >>>> >>>>> From: Christopher Henry <chrisshenry(a)gmail.com> >>>>> Subject: Re: workspace docs on website out of date >>>>> Date: July 2, 2014 at 11:39:23 AM PDT >>>>> To: Nomi Harris <nlharris(a)lbl.gov> >>>>> Cc: Gavin A Price <gavinaprice(a)gmail.com> >>>>> >>>>> Yes! >>>>> >>>>> On Jul 2, 2014, at 1:36 PM, Nomi Harris <nlharris(a)lbl.gov> wrote: >>>>> >>>>>> Ok, so you’re saying the API doc at http://kbase.us/developer-zone/documentation/workspace-service/ already should have been updated to 0.1.6? >>>>>> >>>>>> On Jul 2, 2014, at 11:34 AM, Gavin A Price <gavinaprice(a)gmail.com> wrote: >>>>>> >>>>>>> production has been running 0.1.6 for months. >>>>>>> >>>>>>> production is *also* running 0.0.5 but no one should be using that other than Chris for data transfer and job handling purposes. >>>>>>> >>>>>>> -g >>>>>>> >>>>>>> On 7/2/2014 11:24 AM, Nomi Harris wrote: >>>>>>>> When the production version updates to 0.1.6 then the API doc should get updated during the deploy process. >>>>>>>> >>>>>>>> On Jun 26, 2014, at 4:45 PM, Gavin A Price<gavinaprice(a)gmail.com> wrote: >>>>>>>> >>>>>>>>> It's probably because 0.0.5 is still running in production at the workspace and workspace_service endpoints (I think those are right) because the data transfer is still ongoing and FBA still uses the workspace as a job runner. >>>>>>>>> >>>>>>>>> 0.1.6 is also running at the ws endpoint, but that's the version everyone should be using at this point. >>>>>>>>> >>>>>>>>> -g >>>>>>>>> >>>>>>>>> On 6/26/2014 4:39 PM, Nomi Harris wrote: >>>>>>>>>> When a service is (re)deployed into production, its API doc is supposed to get pushed as well. I’m not sure why that didn’t happen in this case. I will investigate. >>>>>>>>>> >>>>>>>>>> On Jun 26, 2014, at 4:37 PM, Gavin A Price<gavinaprice(a)gmail.com> wrote: >>>>>>>>>> >>>>>>>>>>> It's been brought to my attention that we're still on version 0.0.5 of the workspace docs here: http://kbase.us/developer-zone/documentation/workspace-service/ >>>>>>>>>>> >>>>>>>>>>> Should we update to the 0.1.6 docs, which is currently in production? If so, Nomi, could you explain the process? >>>>>>>>>>> >>>>>>>>>>> Thanks, Gavin >>>>>>>> >> >> _______________________________________________ >> Release-team mailing list >> Release-team(a)lists.kbase.us >> https://lists.kbase.us/mailman/listinfo/release-team > > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us > https://lists.kbase.us/mailman/listinfo/release-team _______________________________________________ Release-team mailing list Release-team(a)lists.kbase.us https://lists.kbase.us/mailman/listinfo/release-team

1 0

Re: [Release-team] Need API doc updated for workspace
by Erik Pearson 03 Jul '14

03 Jul '14

The workspace docs (Perl API, Release Notes) have been updated on the site to release 0.1.6 of workspace_deluxe. In the docs repo they live in workspace_deluxe, and the (internal include) links now reflect this. This was done from outside the workspace_deluxe repo without touching it other than checking out to 0.1.6. For Java API, command line docs, and maybe other stuff, I would need to build workspace in a dev-container, something I’m not yet familiar with. Erik. On Jul 2, 2014, at 2:18 PM, Nomi Harris <nlharris(a)lbl.gov> wrote: > Thanks, Erik. > > I discussed this issue (updating the API docs when needed) with Erik. In the longer term, he will look into automating this. In the short term, he just needs to know when a service has been (re)deployed so he can update the API doc for it. He and I couldn’t think of any way he would know this unless Dan tells him, but if there’s some way he could be automatically informed, please let us know! > > Nomi > > On Jul 2, 2014, at 12:42 PM, Erik Pearson <eapearson(a)lbl.gov> wrote: > >> Okay, so I can either build the docs from the workspace_deluxe repo 0.1.6 release or someone can just send me or point me to the location of the build/deployed docs, in either case I’ll take care of incorporating the workspace docs into the docs repo. >> >> Erik. >> >> >> On Jul 2, 2014, at 12:05 PM, Erik Pearson <eapearson(a)lbl.gov> wrote: >> >>> On Jul 2, 2014, at 11:46 AM, Nomi Harris <nlharris(a)lbl.gov> wrote: >>> >>>> Dear Release Team, >>>> Gavin informed me that the API doc at http://kbase.us/developer-zone/documentation/workspace-service/ is out of date—it should have been updated when the newer version of the workspace service was deployed to production. >>>> >>>> What is the current situation with the updating of these API docs—does it require a human to copy them somewhere, or should that happen automatically when a service is deployed to production? >>> >>> This specific doc needs to appear in the docs repo as workspace_service/workspaceService.html. >>> >>> There is a magic script which which will separate the navigation and the document body and store them in separate files, which are then included directly into the web page (yes, as includes, so whenever the files change the doc web page just shows the new files.) >>> >>> There is a manual step for the API doc — I will notice the commit to the docs repo and do the work. Release notes will be automatically updated since they are read straight from the repo. There is also a related “Command Line Help” document located at docs/command_line_prod/Workspace_Service_CommandLineHelp.txt and will be updated on the site automatically (it is shown simply as a plain text page). >>> >>> We have plans to for a documentation build process including detection of changes to source docs. >>> >>> Erik. >>> >>>> >>>> Also, please add Erik to the release-team mailing list. He is handling the web-facing part (adding the kbase “style” to the API docs). >>>> >>>> Thanks, >>>> Nomi >>>> >>>> Begin forwarded message: >>>> >>>>> From: Christopher Henry <chrisshenry(a)gmail.com> >>>>> Subject: Re: workspace docs on website out of date >>>>> Date: July 2, 2014 at 11:39:23 AM PDT >>>>> To: Nomi Harris <nlharris(a)lbl.gov> >>>>> Cc: Gavin A Price <gavinaprice(a)gmail.com> >>>>> >>>>> Yes! >>>>> >>>>> On Jul 2, 2014, at 1:36 PM, Nomi Harris <nlharris(a)lbl.gov> wrote: >>>>> >>>>>> Ok, so you’re saying the API doc at http://kbase.us/developer-zone/documentation/workspace-service/ already should have been updated to 0.1.6? >>>>>> >>>>>> On Jul 2, 2014, at 11:34 AM, Gavin A Price <gavinaprice(a)gmail.com> wrote: >>>>>> >>>>>>> production has been running 0.1.6 for months. >>>>>>> >>>>>>> production is *also* running 0.0.5 but no one should be using that other than Chris for data transfer and job handling purposes. >>>>>>> >>>>>>> -g >>>>>>> >>>>>>> On 7/2/2014 11:24 AM, Nomi Harris wrote: >>>>>>>> When the production version updates to 0.1.6 then the API doc should get updated during the deploy process. >>>>>>>> >>>>>>>> On Jun 26, 2014, at 4:45 PM, Gavin A Price<gavinaprice(a)gmail.com> wrote: >>>>>>>> >>>>>>>>> It's probably because 0.0.5 is still running in production at the workspace and workspace_service endpoints (I think those are right) because the data transfer is still ongoing and FBA still uses the workspace as a job runner. >>>>>>>>> >>>>>>>>> 0.1.6 is also running at the ws endpoint, but that's the version everyone should be using at this point. >>>>>>>>> >>>>>>>>> -g >>>>>>>>> >>>>>>>>> On 6/26/2014 4:39 PM, Nomi Harris wrote: >>>>>>>>>> When a service is (re)deployed into production, its API doc is supposed to get pushed as well. I’m not sure why that didn’t happen in this case. I will investigate. >>>>>>>>>> >>>>>>>>>> On Jun 26, 2014, at 4:37 PM, Gavin A Price<gavinaprice(a)gmail.com> wrote: >>>>>>>>>> >>>>>>>>>>> It's been brought to my attention that we're still on version 0.0.5 of the workspace docs here: http://kbase.us/developer-zone/documentation/workspace-service/ >>>>>>>>>>> >>>>>>>>>>> Should we update to the 0.1.6 docs, which is currently in production? If so, Nomi, could you explain the process? >>>>>>>>>>> >>>>>>>>>>> Thanks, Gavin >>>>>>>> >> >> _______________________________________________ >> Release-team mailing list >> Release-team(a)lists.kbase.us >> https://lists.kbase.us/mailman/listinfo/release-team > > _______________________________________________ > Release-team mailing list > Release-team(a)lists.kbase.us > https://lists.kbase.us/mailman/listinfo/release-team

1 0