From: "Yoo, Shinjae" <sjyoo@bnl.gov>

Subject: Re: API doc for regprecise [was Re: Initial tech doc results for your module (Full Build, Feb 4, 2013)]

Date: February 13, 2013 12:51:00 AM PST

To: Nomi Harris <nlharris@lbl.gov>

Cc: Pavel Novichkov <psnovichkov@lbl.gov>

Nomi,

Your suggested changes is in place now:

root@ntest:/kb/dev_container/modules/regprecise# ls -al /kb/deployment/services/Regulation/webroot/

total 40

drwxr-xr-x 2 root root  4096 2013-02-13 08:48 .

drwxr-xr-x 3 root root  4096 2013-02-13 08:48 ..

-rw-r--r-- 1 root root 32716 2013-02-13 08:48 Regulation.html

root@ntest:/kb/dev_container/modules/regprecise# 

Please let me know if you have any other issues with Makefile.

Thanks,

-SJ

On Feb 13, 2013, at 3:41 AM, Shinjae Yoo wrote:

Thanks Nomi,

Two things:

1) deploy-docs target fixed last week 

    It seems the Makefile is old version

2) If you want just empty folder as web root, I can make changes to deploy-dir target to have empty webroot folder to copy it.

    I'll make this change now and test it on my test VM.

-SJ

On Feb 12, 2013, at 5:46 PM, Nomi Harris wrote:

(Sorry, forgot to cc you, Shinjae.)

Nomi

Begin forwarded message:

From: Nomi Harris <nlharris@lbl.gov>

Subject: API doc for regprecise [was Re: Initial tech doc results for your module (Full Build, Feb 4, 2013)]

Date: February 12, 2013 11:55:19 AM PST

To: Pavel Novichkov <PSNovichkov@lbl.gov>

Cc: "Tom S. Brettin" <Brettin@mcs.anl.gov>, Shane Canon <scanon@lbl.gov>, Nomi Harris <NLHarris@lbl.gov>

Hi Pavel,
The "deploy-docs" target in your Makefile is still copying docs to the wrong directory; furthermore, by copying docs/*html it copies an index.html that is a Glassfish default page, which then hides the actual API doc (Regulation.html) from being visible in http://140.221.84.191/services/docs/Regulation/ . (If you look there now, you can see Regulation.html only because Shane manually moved index.html to index2.html.)

Your Makefile has:
deploy-docs: build-docs
cp docs/*.html $(TARGET)/services/$(SERVICE_NAME)/webroot/docroot/

It should say (I think--I did not actually test this):
deploy-docs: build-docs
mkdir -p $(TARGET)/services/$(SERVICE_NAME)/webroot
cp docs/Regulation.html $(TARGET)/services/$(SERVICE_NAME)/webroot

Please let us know when you've made that change so we can redeploy regprecise and make sure the API doc ends up in the correct place so that we can clear your module for production release.

Thanks,
Nomi


On Feb 5, 2013, at 9:44 AM, Nomi Harris <nlharris@lbl.gov> wrote:

Dear KBase Module Owner,

Modules are required to have API docs deployed to the appropriate webroot directory in order to be included in the release. For this release, API docs should be visibile in http://140.221.84.191/services/docs/

If your module's Makefile conforms to the KBase standard Makefile, “make deploy” will have run “make deploy-docs”, which should make the html documents and copy them to webroot: ($(TARGET)/services/$(SERVICE)/webroot/ where $(TARGET) is typically /kb/deployment and $(SERVICE) is the name of your service--so, for example, /kb/deployment/services/idserver/webroot). These docs are normally generated from the comments in the typespec.

RESULTS OF TECH DOC CHECK (Full release, week of 2/4/2013)
MODULE NAME: regprecise
AUTHOR(S): psnovichkov@lbl.gov
DIRECTORY FOR API DOCS: http://140.221.84.191/services/docs/Regulation
API DOCS PRESENT AT THAT URL? No--your "deploy-docs" target is copying the docs to the wrong directory. Please change to conform to the standard Makefile, https://git.kbase.us/dev_container.git/blob/HEAD:/doc/module.Makefile for more info.
API DOCS COMPLETE? yes (but in wrong dir)