Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for Gradle changes #735

Merged
merged 2 commits into from
Apr 29, 2024
Merged

Conversation

MrCreosote
Copy link
Member

Also deleted a no longer relevant Shock warning. The documentation needs to be updated for Shock -> Blobstore all over the place, but that's another commit or two.

Also deleted a no longer relevant Shock warning. The documentation needs
to be updated for Shock -> Blobstore all over the place, but that's
another commit or two.
Comment on lines 11 to 12
~$ mkdir kb
~$ cd kb
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at some point those lines could be removed since they are not needed

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed


$ sudo pip install sphinx --upgrade
It will also build the ``build\update_workspace_database_schema`` script which is used to
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is that the right direction for the slash?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope, fixed. No DOS here please


* 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"That code must be reinstated"? "reversed" doesn't quite sound right

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clarified, is that better?

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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Comment on lines +68 to 71

These instructions are known to work on Ubuntu 16.04 LTS.

1. Install the dependencies `Java8 <http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html>`_, `Apache Ant <https://ant.apache.org/bindownload.cgi>`_, pymongo v2.8, `GlassFish v3.1.2.2 <http://www.oracle.com/technetwork/middleware/glassfish/downloads/ogs-3-1-1-downloads-439803.html>`_ , `mongodb >=v2.6.* <https://www.mongodb.com/download-center#atlas>`_, `kb-sdk <https://github.com/kbase/kb_sdk>`_ and the `KBase Jars <https://github.com/kbase/jars>`_ directory.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this being removed in an upcoming PR?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The TODO above covers this - this whole section needs to be nuked and written from scratch

Right now I have no idea when I'll get to that. Maybe if I work on updating Tomcat I'll do it then.

Copy link

codecov bot commented Apr 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.75%. Comparing base (c3785c4) to head (c42c439).
Report is 10 commits behind head on dev-gradle2.

Additional details and impacted files
@@              Coverage Diff               @@
##             dev-gradle2     #735   +/-   ##
==============================================
  Coverage          87.75%   87.75%           
  Complexity          5333     5333           
==============================================
  Files                229      229           
  Lines              17647    17647           
  Branches            2591     2591           
==============================================
  Hits               15486    15486           
  Misses              1701     1701           
  Partials             460      460           

@MrCreosote MrCreosote merged commit 236e2f1 into dev-gradle2 Apr 29, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants