Documentation TODO listΒΆ
Todo
Add js and py documentation when the typecompiler / kb-sdk generates it
(The original entry is located in /tmp/workspace/docsource/api.rst, line 11.)
Todo
This section needs an entire rewrite from scratch with Tomcat as the application server and
a clean, easy install instruction set or a script to set things up correctly (e.g.
the port and memory settings in the deploy.cfg file are currently ignored).
Currently, the easiest way to run the service locally is via docker compose up -d --build
which will start a KBase auth server in testmode and the workspace. If deploying outside
a docker container is required, the best option for now is to inspect the Dockerfile and
attempt to follow the steps there.
Also, the developer and administrator server startup documentation should be unified.
(The original entry is located in /tmp/workspace/docsource/buildandconfigure.rst, line 356.)
Todo
Build (probably not needed) and initialization instructions for the Javascript client.
(The original entry is located in /tmp/workspace/docsource/buildinitclient.rst, line 115.)
Todo
This section needs an entire rewrite from scratch with Tomcat as the application server.
Currently, the easiest way to run the service locally is via docker compose up -d --build
which will start a KBase auth server in testmode and the workspace. If deploying outside
a docker container is required, the best option for now is to inspect the Dockerfile and
attempt to follow the steps there.
Also, the developer and administrator server startup documentation should be unified.
(The original entry is located in /tmp/workspace/docsource/developers.rst, line 62.)
Todo
Update these instructions for the Blobstore, which has replaced Shock.
(The original entry is located in /tmp/workspace/docsource/test.rst, line 11.)
Todo
Move to developer documentation vs. server administrator documenation.
(The original entry is located in /tmp/workspace/docsource/test.rst, line 42.)
Todo
Update this document to use the kb-sdk tools.
(The original entry is located in /tmp/workspace/docsource/typedobjects.rst, line 92.)