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 <[email protected]> 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 <[email protected]> wrote:
On Jul 2, 2014, at 11:46 AM, Nomi Harris <[email protected]> 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 <[email protected]> Subject: Re: workspace docs on website out of date Date: July 2, 2014 at 11:39:23 AM PDT To: Nomi Harris <[email protected]> Cc: Gavin A Price <[email protected]>
Yes!
On Jul 2, 2014, at 1:36 PM, Nomi Harris <[email protected]> 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 <[email protected]> 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<[email protected]> 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<[email protected]> 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 [email protected] https://lists.kbase.us/mailman/listinfo/release-team