diff --git a/Rakefile b/Rakefile index 8628b7c..6581dda 100644 --- a/Rakefile +++ b/Rakefile @@ -4,7 +4,7 @@ task :check_syntax do fail_count = 0 errors = [] - Dir.glob("modules/**/*.rb").sort.each do |file| + Dir.glob("modules/devguide/examples/*/*.rb").sort.each do |file| source = File.read(file) RubyVM::InstructionSequence.compile(source, file) pass += 1 diff --git a/modules/howtos/examples/rails-caching-example/.dockerignore b/modules/devguide/examples/rails-caching-example/.dockerignore similarity index 100% rename from modules/howtos/examples/rails-caching-example/.dockerignore rename to modules/devguide/examples/rails-caching-example/.dockerignore diff --git a/modules/howtos/examples/rails-caching-example/.gitattributes b/modules/devguide/examples/rails-caching-example/.gitattributes similarity index 100% rename from modules/howtos/examples/rails-caching-example/.gitattributes rename to modules/devguide/examples/rails-caching-example/.gitattributes diff --git a/modules/howtos/examples/rails-caching-example/.gitignore b/modules/devguide/examples/rails-caching-example/.gitignore similarity index 100% rename from modules/howtos/examples/rails-caching-example/.gitignore rename to modules/devguide/examples/rails-caching-example/.gitignore diff --git a/modules/howtos/examples/rails-caching-example/.rubocop.yml b/modules/devguide/examples/rails-caching-example/.rubocop.yml similarity index 100% rename from modules/howtos/examples/rails-caching-example/.rubocop.yml rename to modules/devguide/examples/rails-caching-example/.rubocop.yml diff --git a/modules/howtos/examples/rails-caching-example/.ruby-version b/modules/devguide/examples/rails-caching-example/.ruby-version similarity index 100% rename from modules/howtos/examples/rails-caching-example/.ruby-version rename to modules/devguide/examples/rails-caching-example/.ruby-version diff --git a/modules/howtos/examples/rails-caching-example/Dockerfile b/modules/devguide/examples/rails-caching-example/Dockerfile similarity index 100% rename from modules/howtos/examples/rails-caching-example/Dockerfile rename to modules/devguide/examples/rails-caching-example/Dockerfile diff --git a/modules/howtos/examples/rails-caching-example/Gemfile b/modules/devguide/examples/rails-caching-example/Gemfile similarity index 100% rename from modules/howtos/examples/rails-caching-example/Gemfile rename to modules/devguide/examples/rails-caching-example/Gemfile diff --git a/modules/howtos/examples/rails-caching-example/Gemfile.lock b/modules/devguide/examples/rails-caching-example/Gemfile.lock similarity index 100% rename from modules/howtos/examples/rails-caching-example/Gemfile.lock rename to modules/devguide/examples/rails-caching-example/Gemfile.lock diff --git a/modules/howtos/examples/rails-caching-example/README.md b/modules/devguide/examples/rails-caching-example/README.md similarity index 100% rename from modules/howtos/examples/rails-caching-example/README.md rename to modules/devguide/examples/rails-caching-example/README.md diff --git a/modules/howtos/examples/rails-caching-example/Rakefile b/modules/devguide/examples/rails-caching-example/Rakefile similarity index 100% rename from modules/howtos/examples/rails-caching-example/Rakefile rename to modules/devguide/examples/rails-caching-example/Rakefile diff --git a/modules/howtos/examples/rails-caching-example/app/assets/config/manifest.js b/modules/devguide/examples/rails-caching-example/app/assets/config/manifest.js similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/assets/config/manifest.js rename to modules/devguide/examples/rails-caching-example/app/assets/config/manifest.js diff --git a/modules/howtos/examples/rails-caching-example/app/assets/images/.keep b/modules/devguide/examples/rails-caching-example/app/assets/images/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/assets/images/.keep rename to modules/devguide/examples/rails-caching-example/app/assets/images/.keep diff --git a/modules/howtos/examples/rails-caching-example/app/assets/stylesheets/application.css b/modules/devguide/examples/rails-caching-example/app/assets/stylesheets/application.css similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/assets/stylesheets/application.css rename to modules/devguide/examples/rails-caching-example/app/assets/stylesheets/application.css diff --git a/modules/howtos/examples/rails-caching-example/app/controllers/application_controller.rb b/modules/devguide/examples/rails-caching-example/app/controllers/application_controller.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/controllers/application_controller.rb rename to modules/devguide/examples/rails-caching-example/app/controllers/application_controller.rb diff --git a/modules/howtos/examples/rails-caching-example/app/controllers/concerns/.keep b/modules/devguide/examples/rails-caching-example/app/controllers/concerns/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/controllers/concerns/.keep rename to modules/devguide/examples/rails-caching-example/app/controllers/concerns/.keep diff --git a/modules/howtos/examples/rails-caching-example/app/controllers/wall_clock_controller.rb b/modules/devguide/examples/rails-caching-example/app/controllers/wall_clock_controller.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/controllers/wall_clock_controller.rb rename to modules/devguide/examples/rails-caching-example/app/controllers/wall_clock_controller.rb diff --git a/modules/howtos/examples/rails-caching-example/app/helpers/application_helper.rb b/modules/devguide/examples/rails-caching-example/app/helpers/application_helper.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/helpers/application_helper.rb rename to modules/devguide/examples/rails-caching-example/app/helpers/application_helper.rb diff --git a/modules/howtos/examples/rails-caching-example/app/models/application_record.rb b/modules/devguide/examples/rails-caching-example/app/models/application_record.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/models/application_record.rb rename to modules/devguide/examples/rails-caching-example/app/models/application_record.rb diff --git a/modules/howtos/examples/rails-caching-example/app/models/concerns/.keep b/modules/devguide/examples/rails-caching-example/app/models/concerns/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/models/concerns/.keep rename to modules/devguide/examples/rails-caching-example/app/models/concerns/.keep diff --git a/modules/howtos/examples/rails-caching-example/app/views/layouts/application.html.erb b/modules/devguide/examples/rails-caching-example/app/views/layouts/application.html.erb similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/views/layouts/application.html.erb rename to modules/devguide/examples/rails-caching-example/app/views/layouts/application.html.erb diff --git a/modules/howtos/examples/rails-caching-example/app/views/pwa/manifest.json.erb b/modules/devguide/examples/rails-caching-example/app/views/pwa/manifest.json.erb similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/views/pwa/manifest.json.erb rename to modules/devguide/examples/rails-caching-example/app/views/pwa/manifest.json.erb diff --git a/modules/howtos/examples/rails-caching-example/app/views/pwa/service-worker.js b/modules/devguide/examples/rails-caching-example/app/views/pwa/service-worker.js similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/views/pwa/service-worker.js rename to modules/devguide/examples/rails-caching-example/app/views/pwa/service-worker.js diff --git a/modules/howtos/examples/rails-caching-example/app/views/wall_clock/now.html.erb b/modules/devguide/examples/rails-caching-example/app/views/wall_clock/now.html.erb similarity index 100% rename from modules/howtos/examples/rails-caching-example/app/views/wall_clock/now.html.erb rename to modules/devguide/examples/rails-caching-example/app/views/wall_clock/now.html.erb diff --git a/modules/howtos/examples/rails-caching-example/bin/brakeman b/modules/devguide/examples/rails-caching-example/bin/brakeman similarity index 100% rename from modules/howtos/examples/rails-caching-example/bin/brakeman rename to modules/devguide/examples/rails-caching-example/bin/brakeman diff --git a/modules/howtos/examples/rails-caching-example/bin/bundle b/modules/devguide/examples/rails-caching-example/bin/bundle similarity index 100% rename from modules/howtos/examples/rails-caching-example/bin/bundle rename to modules/devguide/examples/rails-caching-example/bin/bundle diff --git a/modules/howtos/examples/rails-caching-example/bin/docker-entrypoint b/modules/devguide/examples/rails-caching-example/bin/docker-entrypoint similarity index 100% rename from modules/howtos/examples/rails-caching-example/bin/docker-entrypoint rename to modules/devguide/examples/rails-caching-example/bin/docker-entrypoint diff --git a/modules/howtos/examples/rails-caching-example/bin/rails b/modules/devguide/examples/rails-caching-example/bin/rails similarity index 100% rename from modules/howtos/examples/rails-caching-example/bin/rails rename to modules/devguide/examples/rails-caching-example/bin/rails diff --git a/modules/howtos/examples/rails-caching-example/bin/rake b/modules/devguide/examples/rails-caching-example/bin/rake similarity index 100% rename from modules/howtos/examples/rails-caching-example/bin/rake rename to modules/devguide/examples/rails-caching-example/bin/rake diff --git a/modules/howtos/examples/rails-caching-example/bin/rubocop b/modules/devguide/examples/rails-caching-example/bin/rubocop similarity index 100% rename from modules/howtos/examples/rails-caching-example/bin/rubocop rename to modules/devguide/examples/rails-caching-example/bin/rubocop diff --git a/modules/howtos/examples/rails-caching-example/bin/setup b/modules/devguide/examples/rails-caching-example/bin/setup similarity index 100% rename from modules/howtos/examples/rails-caching-example/bin/setup rename to modules/devguide/examples/rails-caching-example/bin/setup diff --git a/modules/howtos/examples/rails-caching-example/config.ru b/modules/devguide/examples/rails-caching-example/config.ru similarity index 100% rename from modules/howtos/examples/rails-caching-example/config.ru rename to modules/devguide/examples/rails-caching-example/config.ru diff --git a/modules/howtos/examples/rails-caching-example/config/application.rb b/modules/devguide/examples/rails-caching-example/config/application.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/application.rb rename to modules/devguide/examples/rails-caching-example/config/application.rb diff --git a/modules/howtos/examples/rails-caching-example/config/boot.rb b/modules/devguide/examples/rails-caching-example/config/boot.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/boot.rb rename to modules/devguide/examples/rails-caching-example/config/boot.rb diff --git a/modules/howtos/examples/rails-caching-example/config/credentials.yml.enc b/modules/devguide/examples/rails-caching-example/config/credentials.yml.enc similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/credentials.yml.enc rename to modules/devguide/examples/rails-caching-example/config/credentials.yml.enc diff --git a/modules/howtos/examples/rails-caching-example/config/database.yml b/modules/devguide/examples/rails-caching-example/config/database.yml similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/database.yml rename to modules/devguide/examples/rails-caching-example/config/database.yml diff --git a/modules/howtos/examples/rails-caching-example/config/environment.rb b/modules/devguide/examples/rails-caching-example/config/environment.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/environment.rb rename to modules/devguide/examples/rails-caching-example/config/environment.rb diff --git a/modules/howtos/examples/rails-caching-example/config/environments/development.rb b/modules/devguide/examples/rails-caching-example/config/environments/development.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/environments/development.rb rename to modules/devguide/examples/rails-caching-example/config/environments/development.rb diff --git a/modules/howtos/examples/rails-caching-example/config/environments/production.rb b/modules/devguide/examples/rails-caching-example/config/environments/production.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/environments/production.rb rename to modules/devguide/examples/rails-caching-example/config/environments/production.rb diff --git a/modules/howtos/examples/rails-caching-example/config/environments/test.rb b/modules/devguide/examples/rails-caching-example/config/environments/test.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/environments/test.rb rename to modules/devguide/examples/rails-caching-example/config/environments/test.rb diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/assets.rb b/modules/devguide/examples/rails-caching-example/config/initializers/assets.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/initializers/assets.rb rename to modules/devguide/examples/rails-caching-example/config/initializers/assets.rb diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/content_security_policy.rb b/modules/devguide/examples/rails-caching-example/config/initializers/content_security_policy.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/initializers/content_security_policy.rb rename to modules/devguide/examples/rails-caching-example/config/initializers/content_security_policy.rb diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb b/modules/devguide/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb rename to modules/devguide/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/inflections.rb b/modules/devguide/examples/rails-caching-example/config/initializers/inflections.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/initializers/inflections.rb rename to modules/devguide/examples/rails-caching-example/config/initializers/inflections.rb diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/permissions_policy.rb b/modules/devguide/examples/rails-caching-example/config/initializers/permissions_policy.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/initializers/permissions_policy.rb rename to modules/devguide/examples/rails-caching-example/config/initializers/permissions_policy.rb diff --git a/modules/howtos/examples/rails-caching-example/config/locales/en.yml b/modules/devguide/examples/rails-caching-example/config/locales/en.yml similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/locales/en.yml rename to modules/devguide/examples/rails-caching-example/config/locales/en.yml diff --git a/modules/howtos/examples/rails-caching-example/config/puma.rb b/modules/devguide/examples/rails-caching-example/config/puma.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/puma.rb rename to modules/devguide/examples/rails-caching-example/config/puma.rb diff --git a/modules/howtos/examples/rails-caching-example/config/routes.rb b/modules/devguide/examples/rails-caching-example/config/routes.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/config/routes.rb rename to modules/devguide/examples/rails-caching-example/config/routes.rb diff --git a/modules/howtos/examples/rails-caching-example/db/seeds.rb b/modules/devguide/examples/rails-caching-example/db/seeds.rb similarity index 100% rename from modules/howtos/examples/rails-caching-example/db/seeds.rb rename to modules/devguide/examples/rails-caching-example/db/seeds.rb diff --git a/modules/howtos/examples/rails-caching-example/lib/assets/.keep b/modules/devguide/examples/rails-caching-example/lib/assets/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/lib/assets/.keep rename to modules/devguide/examples/rails-caching-example/lib/assets/.keep diff --git a/modules/howtos/examples/rails-caching-example/lib/tasks/.keep b/modules/devguide/examples/rails-caching-example/lib/tasks/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/lib/tasks/.keep rename to modules/devguide/examples/rails-caching-example/lib/tasks/.keep diff --git a/modules/howtos/examples/rails-caching-example/log/.keep b/modules/devguide/examples/rails-caching-example/log/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/log/.keep rename to modules/devguide/examples/rails-caching-example/log/.keep diff --git a/modules/howtos/examples/rails-caching-example/public/404.html b/modules/devguide/examples/rails-caching-example/public/404.html similarity index 100% rename from modules/howtos/examples/rails-caching-example/public/404.html rename to modules/devguide/examples/rails-caching-example/public/404.html diff --git a/modules/howtos/examples/rails-caching-example/public/406-unsupported-browser.html b/modules/devguide/examples/rails-caching-example/public/406-unsupported-browser.html similarity index 100% rename from modules/howtos/examples/rails-caching-example/public/406-unsupported-browser.html rename to modules/devguide/examples/rails-caching-example/public/406-unsupported-browser.html diff --git a/modules/howtos/examples/rails-caching-example/public/422.html b/modules/devguide/examples/rails-caching-example/public/422.html similarity index 100% rename from modules/howtos/examples/rails-caching-example/public/422.html rename to modules/devguide/examples/rails-caching-example/public/422.html diff --git a/modules/howtos/examples/rails-caching-example/public/500.html b/modules/devguide/examples/rails-caching-example/public/500.html similarity index 100% rename from modules/howtos/examples/rails-caching-example/public/500.html rename to modules/devguide/examples/rails-caching-example/public/500.html diff --git a/modules/howtos/examples/rails-caching-example/public/icon.png b/modules/devguide/examples/rails-caching-example/public/icon.png similarity index 100% rename from modules/howtos/examples/rails-caching-example/public/icon.png rename to modules/devguide/examples/rails-caching-example/public/icon.png diff --git a/modules/howtos/examples/rails-caching-example/public/icon.svg b/modules/devguide/examples/rails-caching-example/public/icon.svg similarity index 100% rename from modules/howtos/examples/rails-caching-example/public/icon.svg rename to modules/devguide/examples/rails-caching-example/public/icon.svg diff --git a/modules/howtos/examples/rails-caching-example/public/robots.txt b/modules/devguide/examples/rails-caching-example/public/robots.txt similarity index 100% rename from modules/howtos/examples/rails-caching-example/public/robots.txt rename to modules/devguide/examples/rails-caching-example/public/robots.txt diff --git a/modules/howtos/examples/rails-caching-example/storage/.keep b/modules/devguide/examples/rails-caching-example/storage/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/storage/.keep rename to modules/devguide/examples/rails-caching-example/storage/.keep diff --git a/modules/howtos/examples/rails-caching-example/tmp/.keep b/modules/devguide/examples/rails-caching-example/tmp/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/tmp/.keep rename to modules/devguide/examples/rails-caching-example/tmp/.keep diff --git a/modules/howtos/examples/rails-caching-example/tmp/pids/.keep b/modules/devguide/examples/rails-caching-example/tmp/pids/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/tmp/pids/.keep rename to modules/devguide/examples/rails-caching-example/tmp/pids/.keep diff --git a/modules/howtos/examples/rails-caching-example/tmp/storage/.keep b/modules/devguide/examples/rails-caching-example/tmp/storage/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/tmp/storage/.keep rename to modules/devguide/examples/rails-caching-example/tmp/storage/.keep diff --git a/modules/howtos/examples/rails-caching-example/vendor/.keep b/modules/devguide/examples/rails-caching-example/vendor/.keep similarity index 100% rename from modules/howtos/examples/rails-caching-example/vendor/.keep rename to modules/devguide/examples/rails-caching-example/vendor/.keep diff --git a/modules/howtos/examples/analytics.rb b/modules/devguide/examples/ruby/analytics.rb similarity index 100% rename from modules/howtos/examples/analytics.rb rename to modules/devguide/examples/ruby/analytics.rb diff --git a/modules/howtos/examples/auth.rb b/modules/devguide/examples/ruby/auth.rb similarity index 100% rename from modules/howtos/examples/auth.rb rename to modules/devguide/examples/ruby/auth.rb diff --git a/modules/howtos/examples/cas.rb b/modules/devguide/examples/ruby/cas.rb similarity index 100% rename from modules/howtos/examples/cas.rb rename to modules/devguide/examples/ruby/cas.rb diff --git a/modules/hello-world/examples/cloud.rb b/modules/devguide/examples/ruby/cloud.rb similarity index 100% rename from modules/hello-world/examples/cloud.rb rename to modules/devguide/examples/ruby/cloud.rb diff --git a/modules/concept-docs/examples/collections.rb b/modules/devguide/examples/ruby/collections.rb similarity index 100% rename from modules/concept-docs/examples/collections.rb rename to modules/devguide/examples/ruby/collections.rb diff --git a/modules/concept-docs/examples/documents.rb b/modules/devguide/examples/ruby/documents.rb similarity index 100% rename from modules/concept-docs/examples/documents.rb rename to modules/devguide/examples/ruby/documents.rb diff --git a/modules/howtos/examples/error_handling.rb b/modules/devguide/examples/ruby/error_handling.rb similarity index 100% rename from modules/howtos/examples/error_handling.rb rename to modules/devguide/examples/ruby/error_handling.rb diff --git a/modules/howtos/examples/kv_counter.rb b/modules/devguide/examples/ruby/kv_counter.rb similarity index 100% rename from modules/howtos/examples/kv_counter.rb rename to modules/devguide/examples/ruby/kv_counter.rb diff --git a/modules/howtos/examples/kv_operations.rb b/modules/devguide/examples/ruby/kv_operations.rb similarity index 100% rename from modules/howtos/examples/kv_operations.rb rename to modules/devguide/examples/ruby/kv_operations.rb diff --git a/modules/howtos/examples/managing_connections.rb b/modules/devguide/examples/ruby/managing_connections.rb similarity index 100% rename from modules/howtos/examples/managing_connections.rb rename to modules/devguide/examples/ruby/managing_connections.rb diff --git a/modules/howtos/examples/managing_users.rb b/modules/devguide/examples/ruby/managing_users.rb similarity index 100% rename from modules/howtos/examples/managing_users.rb rename to modules/devguide/examples/ruby/managing_users.rb diff --git a/modules/howtos/examples/provisioning-resources-buckets.rb b/modules/devguide/examples/ruby/provisioning-resources-buckets.rb similarity index 100% rename from modules/howtos/examples/provisioning-resources-buckets.rb rename to modules/devguide/examples/ruby/provisioning-resources-buckets.rb diff --git a/modules/howtos/examples/provisioning-resources-collections.rb b/modules/devguide/examples/ruby/provisioning-resources-collections.rb similarity index 100% rename from modules/howtos/examples/provisioning-resources-collections.rb rename to modules/devguide/examples/ruby/provisioning-resources-collections.rb diff --git a/modules/howtos/examples/queries.rb b/modules/devguide/examples/ruby/queries.rb similarity index 100% rename from modules/howtos/examples/queries.rb rename to modules/devguide/examples/ruby/queries.rb diff --git a/modules/howtos/examples/search.rb b/modules/devguide/examples/ruby/search.rb similarity index 100% rename from modules/howtos/examples/search.rb rename to modules/devguide/examples/ruby/search.rb diff --git a/modules/hello-world/examples/start_using.rb b/modules/devguide/examples/ruby/start_using.rb similarity index 100% rename from modules/hello-world/examples/start_using.rb rename to modules/devguide/examples/ruby/start_using.rb diff --git a/modules/howtos/examples/subdoc.rb b/modules/devguide/examples/ruby/subdoc.rb similarity index 100% rename from modules/howtos/examples/subdoc.rb rename to modules/devguide/examples/ruby/subdoc.rb diff --git a/modules/howtos/examples/test.rb b/modules/devguide/examples/ruby/test.rb similarity index 100% rename from modules/howtos/examples/test.rb rename to modules/devguide/examples/ruby/test.rb diff --git a/modules/howtos/examples/views.rb b/modules/devguide/examples/ruby/views.rb similarity index 100% rename from modules/howtos/examples/views.rb rename to modules/devguide/examples/ruby/views.rb diff --git a/modules/hello-world/pages/overview.adoc b/modules/hello-world/pages/overview.adoc index 1a4a7e2..f1f8c17 100644 --- a/modules/hello-world/pages/overview.adoc +++ b/modules/hello-world/pages/overview.adoc @@ -7,7 +7,7 @@ [source,ruby] ---- -include::howtos:example$kv_operations.rb[tag=named-collection-upsert] +include::devguide:example$ruby/kv_operations.rb[tag=named-collection-upsert] ---- The Couchbase Ruby SDK allows you to connect to a Couchbase cluster from Ruby. diff --git a/modules/hello-world/pages/start-using-sdk.adoc b/modules/hello-world/pages/start-using-sdk.adoc index 42daa58..9abbe2c 100644 --- a/modules/hello-world/pages/start-using-sdk.adoc +++ b/modules/hello-world/pages/start-using-sdk.adoc @@ -36,7 +36,7 @@ If you are connecting to https://docs.couchbase.com/cloud/index.html[Couchbase C [source,ruby] ---- -include::hello-world:example$cloud.rb[tags=**] +include::devguide:example$ruby/cloud.rb[tags=**] ---- The Couchbase Capella free tier version comes with the Travel Sample Bucket, and its Query indexes, loaded and ready. @@ -47,7 +47,7 @@ Local Couchbase Server:: -- [source,ruby] ---- -include::hello-world:example$start_using.rb[tags=**] +include::devguide:example$ruby/start_using.rb[tags=**] ---- As well as the Ruby SDK (see below), and a running instance of Couchbase Server, you will need to load up the Travel Sample Bucket diff --git a/modules/howtos/pages/analytics-using-sdk.adoc b/modules/howtos/pages/analytics-using-sdk.adoc index 3e3da6b..9e74925 100644 --- a/modules/howtos/pages/analytics-using-sdk.adoc +++ b/modules/howtos/pages/analytics-using-sdk.adoc @@ -24,7 +24,7 @@ In these examples we will be using an `airports` dataset created on the `travel- [source,ruby] ---- -include::example$analytics.rb[tag=simple] +include::devguide:example$ruby/analytics.rb[tag=simple] ---- @@ -36,13 +36,13 @@ If parameters are used, they can either be `positional` or `named`: .Positional parameters [source,ruby] ---- -include::example$analytics.rb[tag=positional] +include::devguide:example$ruby/analytics.rb[tag=positional] ---- .Named parameters [source,ruby] ---- -include::example$analytics.rb[tag=named] +include::devguide:example$ruby/analytics.rb[tag=named] ---- NOTE: As timeouts are propagated to the server by the client, a timeout set on the client side may be used to stop the processing of a request, in order to save system resources. @@ -72,21 +72,21 @@ Here, we set a `client_context_id`: [source,ruby] ---- -include::example$analytics.rb[tag=clientcontextid] +include::devguide:example$ruby/analytics.rb[tag=clientcontextid] ---- And here we set high priority for the query: [source,ruby] ---- -include::example$analytics.rb[tag=priority] +include::devguide:example$ruby/analytics.rb[tag=priority] ---- Here we pass `readonly` to explicitly mark a query as being read only, and not mutating any documents on the server side. [source,ruby] ---- -include::example$analytics.rb[tag=readonly] +include::devguide:example$ruby/analytics.rb[tag=readonly] ---- @@ -116,7 +116,7 @@ The `metadata` object contains useful metadata, such as `Metrics` and `ClientCon [source,ruby] ---- -include::example$analytics.rb[tag=printmetrics] +include::devguide:example$ruby/analytics.rb[tag=printmetrics] ---- // For a listing of available `Metrics` in `MetaData`, see the xref:concept-docs:analytics-for-sdk-users.adoc[Understanding Analytics] SDK doc. @@ -131,7 +131,7 @@ Analytics allows `:request_plus` queries -- ensuring results contain information [source,ruby] ---- -include::example$analytics.rb[tag=scanconsistency] +include::devguide:example$ruby/analytics.rb[tag=scanconsistency] ---- @@ -149,12 +149,12 @@ You can run a query as follows: [source,ruby] ---- -include::example$analytics.rb[tag=handle-collection] +include::devguide:example$ruby/analytics.rb[tag=handle-collection] ---- In addition to running a query via the `Cluster` object, you can run one via the `Scope` object. [source,ruby] ---- -include::example$analytics.rb[tag=handle-scope] +include::devguide:example$ruby/analytics.rb[tag=handle-scope] ---- diff --git a/modules/howtos/pages/caching-example.adoc b/modules/howtos/pages/caching-example.adoc index a5c2b85..c76b6cb 100644 --- a/modules/howtos/pages/caching-example.adoc +++ b/modules/howtos/pages/caching-example.adoc @@ -7,7 +7,7 @@ This example demonstrates how to integrate Couchbase into a caching layer of the https://rubyonrails.org/[Rails] web-framework. -You can also find the https://github.com/couchbase/docs-sdk-ruby/blob/temp/3.5/modules/howtos/examples/rails-caching-example[full code for _this_ example here]. +You can also find the https://github.com/couchbase/docs-sdk-ruby/blob/temp/3.8/modules/devguide/examples/rails-caching-example[full code for _this_ example here]. == Configuration @@ -17,7 +17,7 @@ so to add it to the application you just need to update your `Gemfile`: [source,ruby] ---- -include::howtos:example$rails-caching-example/Gemfile[tag=add_dependency] +include::devguide:example$rails-caching-example/Gemfile[tag=add_dependency] ---- Do not forget to run `bundle install` to ensure that all dependencies have been satisfied. @@ -27,7 +27,7 @@ Corresponding configuration usually kept in the configuration environment file a [source,ruby] ---- -include::howtos:example$rails-caching-example/config/environments/development.rb[tag=cache_store_config] +include::devguide:example$rails-caching-example/config/environments/development.rb[tag=cache_store_config] ---- In this development example, we will try to discover cluster location and credentials in the environment variables, with a fallback to localhost and safe default. @@ -41,7 +41,7 @@ In this example, we cache the current time for the 3 seconds: [source,ruby] ---- -include::howtos:example$rails-caching-example/app/controllers/wall_clock_controller.rb[tag=cache_time_for_3_seconds] +include::devguide:example$rails-caching-example/app/controllers/wall_clock_controller.rb[tag=cache_time_for_3_seconds] ---- diff --git a/modules/howtos/pages/concurrent-document-mutations.adoc b/modules/howtos/pages/concurrent-document-mutations.adoc index c8fb125..9c6f21a 100644 --- a/modules/howtos/pages/concurrent-document-mutations.adoc +++ b/modules/howtos/pages/concurrent-document-mutations.adoc @@ -29,7 +29,7 @@ include::{version-common}@sdk:shared:partial$cas.adoc[tag=locking] [source,ruby] ---- -include::example$cas.rb[tag=locking] +include::devguide:example$ruby/cas.rb[tag=locking] ---- The handler will unlock the item either via an explicit unlock operation ([.api]`unlock`) or implicitly via modifying the item with the correct CAS. diff --git a/modules/howtos/pages/error-handling.adoc b/modules/howtos/pages/error-handling.adoc index 0348302..6238455 100644 --- a/modules/howtos/pages/error-handling.adoc +++ b/modules/howtos/pages/error-handling.adoc @@ -71,7 +71,7 @@ Transient errors -- such as those caused by resource starvation -- are best tack //// [source,ruby] ---- -include::example$error_handling.rb[tag=handle_retryable] +include::devguide:example$ruby/error_handling.rb[tag=handle_retryable] ---- //// @@ -84,14 +84,14 @@ Here we will cover some of the most common errors. [source,ruby] ---- -include::example$error_handling.rb[tag=DocumentNotFound] +include::devguide:example$ruby/error_handling.rb[tag=DocumentNotFound] ---- === Document already exists [source,ruby] ---- -include::example$error_handling.rb[tag=DocumentExists] +include::devguide:example$ruby/error_handling.rb[tag=DocumentExists] ---- === Document too large @@ -102,21 +102,21 @@ include::example$error_handling.rb[tag=DocumentExists] [source,ruby] ---- -include::example$error_handling.rb[tag=CasMismatch] +include::devguide:example$ruby/error_handling.rb[tag=CasMismatch] ---- === Durability ambiguous [source,ruby] ---- -include::example$error_handling.rb[tag=DurabilityAmbiguous] +include::devguide:example$ruby/error_handling.rb[tag=DurabilityAmbiguous] ---- === Durability invalid level [source,ruby] ---- -include::example$error_handling.rb[tag=DurabilityLevelNotAvailable] +include::devguide:example$ruby/error_handling.rb[tag=DurabilityLevelNotAvailable] ----