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

API docs for your module
by Nomi Harris 24 Jan '13

24 Jan '13

Dear KBase Module Owner, Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is: If the 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. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME. RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013) MODULE NAME: registry AUTHOR(S): Tom DIRECTORY FOR API DOCS: http://140.221.92.231/services/docs/registry API DOCS PRESENT AT THAT URL? No--directory does not exist, though Makefile does have deploy-docs target. API DOCS OK? No. No API docs at URL. Typespec seems to be reasonably well-commented, though lacking a top-level description.

1 0

Self-cc behavior of [email protected]
by Nomi Harris 24 Jan '13

24 Jan '13

Hi Dan, The release-team mailing list, like all of our mailing lists, seems to default to NOT sending a copy of the message to the sender. I find this endlessly frustrating, as I usually DO want to keep a copy and forget to cc myself. If no one else minds, would it be possible to change the behavior so it DOES send the message back to the sender? Thanks, Nomi

1 0

API docs for your module
by Nomi Harris 24 Jan '13

24 Jan '13

Dear KBase Module Owner, Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is: If the 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. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME. RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013) MODULE NAME: KBaseFBAModeling AUTHOR(S): Chris H., Matt DeJongh DIRECTORY FOR API DOCS: http://140.221.92.231/services/docs/KBaseFBAModeling API DOCS PRESENT AT THAT URL? yes API DOCS OK? yes

1 0

API docs for your module
by Nomi Harris 24 Jan '13

24 Jan '13

Dear KBase Module Owner, Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is: If the 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. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME. RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013) MODULE NAME: typecomp AUTHOR(S): Bob Olson DIRECTORY FOR API DOCS: (none) API DOCS PRESENT AT THAT URL? No API DOCS OK? No API docs--but typecomp doesn't have an API, does it? So I guess it's ok?

1 0

API docs for your module
by Nomi Harris 24 Jan '13

24 Jan '13

Dear KBase Module Owner, Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is: If the 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. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME. RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013) MODULE NAME: sim_service AUTHOR(S): Bob Olson DIRECTORY FOR API DOCS: http://140.221.92.231/services/docs/sim_service API DOCS PRESENT AT THAT URL? No--docs not deployed. (No "deploy-docs" target in Makefile.) API DOCS OK? No

1 0

API docs for your module
by Nomi Harris 24 Jan '13

24 Jan '13

Dear KBase Module Owner, Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is: If the 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. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME. RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013) MODULE NAME: kb_seed AUTHOR(S): Bob Olson DIRECTORY FOR API DOCS: http://140.221.92.231/services/docs/cdmi_api API DOCS PRESENT AT THAT URL? yes API DOCS OK? yes

1 0

API docs for your module
by Nomi Harris 24 Jan '13

24 Jan '13

Dear KBase Module Owner, Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is: If the 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. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME. RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013) MODULE NAME: kb_seed AUTHOR(S): Bob Olson DIRECTORY FOR API DOCS: http://140.221.92.231/services/docs/cdmi_api API DOCS PRESENT AT THAT URL? yes API DOCS OK? yes

1 0

API docs for your module
by Nomi Harris 24 Jan '13

24 Jan '13

Dear KBase Module Owner, Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is: If the 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. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME. RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013) MODULE NAME: genome_annotation AUTHOR(S): Bob Olson DIRECTORY FOR API DOCS: http://140.221.92.231/services/docs/genome_annotation API DOCS PRESENT AT THAT URL? yes API DOCS OK? yes (though missing top-level description)

1 0

API docs for your module
by Nomi Harris 24 Jan '13

24 Jan '13

Dear KBase Module Owner, Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is: If the 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. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME. RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013) MODULE NAME: erdb_service AUTHOR(S): Gavin, Keith DIRECTORY FOR API DOCS: http://140.221.92.231/services/docs/erdb_service API DOCS PRESENT AT THAT URL? yes API DOCS OK? yes

1 0

API docs for your module
by Nomi Harris 24 Jan '13

24 Jan '13

Dear KBase Module Owner, Modules are now required to have API docs up at http://140.221.92.231/services/docs/ in order to be included in the release. https://trac.kbase.us/projects/kbase/wiki/TechDocChecking describes the process the Tech Doc team uses to check API docs and other relevant documentation. The key step is: If the 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. If the html API docs are properly made during the deploy, you should be able to see them at http://140.221.92.231/services/docs/SERVICE_NAME. RESULTS OF TECH DOC CHECK (Minor release, week of 1/21/2013) MODULE NAME: communities_qc AUTHOR(S): Andreas, Tobias DIRECTORY FOR API DOCS: http://140.221.92.231/services/docs/communities_qc API DOCS PRESENT AT THAT URL? yes API DOCS OK? yes

1 0