Feature #23064
closed
New "contrib" directory in the source
Description
There are parts of the Arvados source tree that are not "core" to using Arvados and we de facto do not hold to the same development and testing standards as core components. These include the Java and R SDKs (tested separately) and arvbash (not tested at all).
Start a new contrib directory in the Arvados source repository. Move these three components into that. Update code that refers to those components with these new paths (I'm mostly thinking of build/run-tests.sh and doc/Rakefile). Add a README to the directory that explains that these components have lower support standards.
Update the documentation for the Java and R SDKs that similarly explain they're less tested than the other SDKs. (I think we have a note about this on the SDK overview page but not on the page for each SDK.)
In the future we will put tool scripts like arv-import, arv-export, and arv-seed in here too.
Updated by Brett Smith 8 months ago
- Target version set to Development 2025-08-06
- Assigned To set to Brett Smith
- Status changed from New to In Progress
23064-contrib @ 109a301d6621a724a73993a8a70b48866042da01
developer-run-tests-doc-sdk-java-R: #2244
- All agreed upon points are implemented / addressed. Describe changes from pre-implementation design.
- Yes
- Anything not implemented (discovered or discussed during work) has a follow-up story.
- N/A
- Code is tested and passing, both automated and manual, what manual testing was done is described.
- See above
- Tested code incorporates recent main branch changes.
- Yes
- New or changed UI/UX and has gotten feedback from stakeholders.
- N/A (but both Tom and Sasha have signed off on this approach)
- Documentation has been updated.
- Yes. I didn't make any changes to the front page of the R SDK because it already has some verbiage about it being incomplete. I figure that's disclaimer enough that it didn't seem worth it to get into R code.
- Behaves appropriately at the intended scale (describe intended scale).
- No change
- Considered backwards and forwards compatibility issues between client and server.
- N/A
- Follows our coding standards and GUI style guidelines.
- Yes
Updated by Brett Smith 8 months ago
Some paths in .gitignore need to be updated with this branch. IMO that can be done without review, it's a straightforward update and low-risk. But flagging I am aware of it.
Updated by