Start auto-building docs

.github/workflows/actions.yml

@@ -0,0 +1,18 @@
+name: GitHub Actions Demo
+run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
+on: [push]
+jobs:
+  Explore-GitHub-Actions:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
+      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
+      - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
+      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
+      - name: List files in the repository
+        run: |
+          ls ${{ github.workspace }}
+      - run: echo "🍏 This job's status is ${{ job.status }}."

.gitignore

@@ -66,3 +66,4 @@ node_modules
 aterm.jar
 
 public 
+doc

.yardoc/checksums

@@ -0,0 +1,62 @@
+app/models/user.rb dd427c5c41e4048ea9f94429244e330b69f141f7
+app/models/store.rb 2170c4b98fb9fc9771cd2698a74cad9c0882fe76
+lib/xml_utilities.rb a352d8e1709fa08f02e1cd9d21ae838e554e8bed
+app/models/project.rb 393eb143b6aecde23a7f25f993129255040f99ba
+app/models/user_job.rb e59099dcaacf7acbceaa661c109794c1546e2e28
+app/models/affiliation.rb 077f15975f752f2cfbd20377c249df02b4e646b6
+app/jobs/application_job.rb 71882660288cc7e08359e6150dac5e035f2c9040
+app/models/read_only_user.rb 9a7073b4246aea6f1e98960ca6179c1221d302d4
+app/models/version_footer.rb cbf26303b4428acf1ba6cc8f850c4c960a7e83f8
+app/services/pul_datacite.rb a8b2e2b28d4096488e45d8900fdb334840000fb2
+app/helpers/project_helper.rb dfb79a30adeb0c1483d65df919d2c2567d7bad03
+app/models/mediaflux/asset.rb de454b05b2e81125dadae152f74e7f7492206d5d
+app/models/project_metadata.rb 11eca69a13faf0522e37bd6f24e8dae22e0ec91a
+app/models/provenance_event.rb f7c4aee548b600c57ac28e5aba7d1aba436a91af
+app/models/tigerdata_schema.rb eaeea340fb27e82d12afdf69a578eb6f685a6c81
+lib/tiger_data/mailer_error.rb 58691f04019fc58fd42762b0693a53387eb5b9a1
+app/mailers/tigerdata_mailer.rb 37ef85ff539c7cab166c6a66edb5e805ce09a612
+app/models/project_mediaflux.rb 2a03a94128bf29515b5e37c5da8dff37b074831f
+app/models/project_validator.rb 5cc0452fefb3dc54bc0f0233650ce95bbc868e30
+app/models/application_record.rb 1e278510dce60010e1d690fea7ba17b79718b531
+app/helpers/application_helper.rb 76b79ac83d25d08371f379056455e91849d0954a
+app/mailers/application_mailer.rb 356687c652b87e7fde882aca221d0d03768aa86f
+app/services/project_job_service.rb b3c940122a750eefd4b6d82e83e347635405a6c3
+app/models/mediaflux/http/request.rb 8ccfca8f189a15746546fb034c91c2cd0af81cf6
+app/services/test_asset_generator.rb a44d54f09180d4439a61e2b30c29d7bdaf0ff911
+app/controllers/welcome_controller.rb d89bd24fae0d1a8480672485cf7fb8051e97d970
+app/jobs/list_project_contents_job.rb 0efa0c7b9723b1d74390fc9688b09e60edae700f
+app/controllers/projects_controller.rb 8bd664f636674ab73abe52c5577025360549d289
+app/services/test_project_generator.rb b30fded6069301eeade8364b08b18e2abaf591bb
+app/channels/application_cable/channel.rb 1817e997150989002da70e4175428a666a0a1808
+app/controllers/application_controller.rb 0a8516eadbc9f30c32d8fb556447972ac186e932
+app/models/mediaflux/http/logon_request.rb 8a7b2bd6d4fee5246aedc0ec9be99e70df59c52f
+app/models/mediaflux/http/query_request.rb f3318a57c1f4ef9aff60e5f29a4ddca31b7af49d
+app/controllers/organizations_controller.rb e892122c77cd6a4907df3605840efc261f62a0c8
+app/models/mediaflux/http/logout_request.rb 0e420a4684a39be101d6acf5334ae13614c6b9eb
+app/channels/application_cable/connection.rb 5ed8358b69bbfbb8e55cb929d53623b6cbf7e300
+app/controllers/mediaflux_info_controller.rb e16925b8c6989f8dd8de6c60bb145ab4fe68ce95
+app/models/mediaflux/http/http_connection.rb 9e6feaed4b4c8e620e660987f6704135580d9cec
+app/models/mediaflux/http/session_expired.rb c3ad6387e95b916a420329bd48cfed6023d43ae7
+app/models/mediaflux/http/version_request.rb cddfc5b5a216ba4f80497d835386f9bd18b21518
+app/models/mediaflux/http/iterator_request.rb 643f7ee4a081252b60134442a27c81447a39e38f
+app/models/mediaflux/http/store_list_request.rb 7f7689e723577802f1b7de520ee352a6c5e9aac9
+app/models/mediaflux/http/range_query_request.rb 3e7df99fdb7dacdb3a003cbd4eef7101526f9576
+app/models/mediaflux/http/create_asset_request.rb d7d93945d6d001171c4d2aea21b3103e78b5a3ad
+app/models/mediaflux/http/create_token_request.rb bdcf9daa0668cd55e2066850bd6369f350d1b233
+app/models/mediaflux/http/get_metadata_request.rb 4ec2422a195970ae41a64ec19e71284a786ad5c5
+app/models/mediaflux/http/update_asset_request.rb 27a105f035c9f7546e2467c49ac7d813165afa0e
+app/models/mediaflux/http/destroy_asset_request.rb 50f7a92036ef49f7e35cb3fadd040acb16f96521
+app/models/mediaflux/http/schema_create_request.rb 2b724e9bef00940e56e2e08ac20130acd6af331b
+app/models/mediaflux/http/namespace_list_request.rb 250f5aa95c0e67ab2dbf0d26ece725c063645197
+app/models/mediaflux/http/collection_list_request.rb e6314aaf99a5e289398d0f4d9099b740fc743d49
+app/models/mediaflux/http/service_execute_request.rb fbc674707fbe30df26641e9668657724dd2e9bdb
+app/models/mediaflux/http/collection_count_request.rb 3b6b01e728b7d859dce8c54a0eb3c58a9e2d4f79
+app/models/mediaflux/http/collection_query_request.rb bad0cf932bc2f1debcac5f206a3e69b00fdfcd49
+app/models/mediaflux/http/iterator_destroy_request.rb d07573b68e9eda94051afd8bf5ea7eec4cee0c09
+app/models/mediaflux/http/namespace_create_request.rb 84d9fb02498f3fbcee669e10238b02a69ea27ffd
+app/controllers/users/omniauth_callbacks_controller.rb e31a5cda90d3a61adc44a615e84c3e5ed39eee68
+app/models/mediaflux/http/test_asset_create_request.rb 83c7165d2b3889403d91947604c1d33e06112fe8
+app/models/mediaflux/http/namespace_describe_request.rb 8d99ba69041a7674a89ff9e19e5971c94fe59c9e
+app/models/mediaflux/http/schema_fields_create_request.rb 958594f43d6276c22ba41901df7a2db1a4f52348
+app/models/mediaflux/http/create_collection_quota_request.rb 48c736e08d0a1eec81b5ffa15373cf0dd340ec77
+app/models/mediaflux/http/create_collection_accumulator_request.rb a9a2382927d52b19946bfdaf331e879ba0000ff6

Gemfile

@@ -99,6 +99,7 @@ group :development do
   gem "capistrano", "~> 3.17", require: false
   gem "capistrano-passenger"
   gem "capistrano-rails", "~> 1.6", require: false
+  gem "yard" # auto generate documentation
 end
 
 group :test do

Gemfile.lock

@@ -495,6 +495,7 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
+    yard (0.9.36)
     zeitwerk (2.6.12)
 
 PLATFORMS
@@ -553,6 +554,7 @@ DEPENDENCIES
   vite_rails
   web-console
   webmock
+  yard
 
 RUBY VERSION
    ruby 3.2.3p157

app/models/project_mediaflux.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+# Create a project in mediaflux. Follow the process documented by Chuck Bentler in this video:
+# https://drive.google.com/file/d/1fYGNkVM9J94J1jUmZ7p0MZEUX2meLZav/view
 class ProjectMediaflux
   def self.create!(project:, session_id:, xml_namespace: nil)
     store_name = Store.default(session_id: session_id).name