Skip to content

Commit

Permalink
Docs clarifications & fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
MrCreosote committed Apr 25, 2024
1 parent 53d7dd4 commit c42c439
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
11 changes: 5 additions & 6 deletions docsource/buildandconfigure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@ Build the workspace service

Get the code::

~$ mkdir kb
~$ cd kb
~/kb$ git clone https://github.com/kbase/workspace_deluxe

~$ git clone https://github.com/kbase/workspace_deluxe

Build::

~/kb$ cd workspace_deluxe/
~/kb/workspace_deluxe$ ./gradlew buildAll
~$ cd workspace_deluxe/
~/workspace_deluxe$ ./gradlew buildAll
*snip*

``buildAll`` will build 3 jars in ``build/libs``:
Expand All @@ -25,7 +24,7 @@ Build::
* A workspace shadow jar containing all test code. This is useful for starting a workpace server
from other processes without needing a docker container, but should **only** be used for testing.

It will also build the ``build\update_workspace_database_schema`` script which is used to
It will also build the ``build/update_workspace_database_schema`` script which is used to
update the workspace schema if it changes from one version to another.

.. _servicedeps:
Expand Down
4 changes: 3 additions & 1 deletion docsource/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ Note that:

* The `kb-sdk <https://github.com/kbase/kb_sdk>`_ executable must be in the system path.
* The WorkspaceServer class compiled in constructor has been commented out in order to use
a custom constructor. That must be reversed for the compile to work.
a custom constructor. In order for the compile to succeed, the custom constructor must be
commented out and the compiled in constructor uncommented. When the compile is complete the
constructors must be switched back.

Release checklist
-----------------
Expand Down

0 comments on commit c42c439

Please sign in to comment.