Ruby master + Ruby 3.3 Ruby 3.2 Ruby 3.1 Ruby 3.0 diff --git a/public/ja/index.html b/public/ja/index.html index e1d3379..daf5294 100644 --- a/public/ja/index.html +++ b/public/ja/index.html @@ -24,10 +24,10 @@

プログラミング言語 Ruby リファレンスマニュアル

常に最新のバージョンのドキュメントを参照したい場合は上のリンク先が使えます。

+ Ruby 3.3 Ruby 3.2 Ruby 3.1 Ruby 3.0 - Ruby 2.7

注： Rubyは2.1.0からSemantic Versioningを採用しています。 Ruby 2.1.1, 2.1.2等はバグ修正やセキュリティfixのみを含むため、リファレンスとしては2.1に統一しています。 @@ -37,6 +37,7 @@

プログラミング言語 Ruby リファレンスマニュアル

Other versions

Ruby 開発版 + Ruby 2.7 (2023/04 サポート終了) Ruby 2.6 (2022/04 サポート終了) Ruby 2.5 (2021/04/01 サポート終了) Ruby 2.4 (2020/04/01 サポート終了) diff --git a/system/bc-setup-all b/system/bc-setup-all index 5f80b0e..2424cc0 100755 --- a/system/bc-setup-all +++ b/system/bc-setup-all @@ -3,11 +3,11 @@ require 'fileutils' VERSIONS = %w[ - 2.7.0 3.0 3.1 3.2 3.3 + 3.4 ] RUBY = "ruby" diff --git a/system/bc-static-all b/system/bc-static-all index 3f6c5c6..fca8ac2 100755 --- a/system/bc-static-all +++ b/system/bc-static-all @@ -1,11 +1,11 @@ #!/usr/bin/env ruby VERSIONS = %w[ - 2.7.0 3.0 3.1 3.2 3.3 + 3.4 ] RUBY = "ruby" diff --git a/system/rdoc-static-all b/system/rdoc-static-all index dbf13c9..4c1d0fe 100755 --- a/system/rdoc-static-all +++ b/system/rdoc-static-all @@ -1,10 +1,10 @@ #!/usr/bin/env ruby VERSIONS = %w[ - 2.7.0 3.0 3.1 3.2 + 3.3 master ] From 7f6c87f4263ff647cd3b142999a7e9266a5034bb Mon Sep 17 00:00:00 2001 From: "yuta.onishi" Date: Mon, 22 Jan 2024 22:45:00 +0900 Subject: [PATCH 03/50] fix bloken link of semantic versioning --- public/ja/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/ja/index.html b/public/ja/index.html index daf5294..9f09739 100644 --- a/public/ja/index.html +++ b/public/ja/index.html @@ -29,7 +29,7 @@

プログラミング言語 Ruby リファレンスマニュアル

Ruby 3.1 Ruby 3.0

- 注： Rubyは2.1.0からSemantic Versioningを採用しています。 + 注： Rubyは2.1.0からSemantic Versioningを採用しています。 Ruby 2.1.1, 2.1.2等はバグ修正やセキュリティfixのみを含むため、リファレンスとしては2.1に統一しています。

るりまサーチ (全文検索) From be6b66c3e40ea9e2f912403db7899dea342cbcba Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Thu, 29 Feb 2024 11:32:30 +0900 Subject: [PATCH 04/50] Download docs tarball generated by GitHub Actions --- system/rdoc-static-all | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/system/rdoc-static-all b/system/rdoc-static-all index 4c1d0fe..b0d975f 100755 --- a/system/rdoc-static-all +++ b/system/rdoc-static-all @@ -12,11 +12,11 @@ DOC_ROOT = ENV.fetch('DOC_ROOT', "/var/www/docs.ruby-lang.org/shared/public/en") Dir.chdir(File.join(__dir__, '..')) -def create_document(version) - system("bundle", "install") or raise - system("bundle", "exec", "rake", "update:#{version}") or raise - system("rm", "-rf", version) or raise - system("bundle", "exec", "rake", "rdoc:en/#{version}") or raise +def download_document(version) + system("rm", "-rf", version, "ruby-docs-en-#{version}.tar.xz") or raise + system("curl", "-sSLO", "https://cache.ruby-lang.org/pub/ruby/doc/ruby-docs-en-#{version}.tar.xz") or raise + system("ls", "-l", "ruby-docs-en-#{version}.tar.xz") + system("tar", "xf", "https://cache.ruby-lang.org/pub/ruby/doc/ruby-docs-en-#{version}.tar.xz") or raise system("rsync", "-acvi", "--no-times", "--delete", version, DOC_ROOT) or raise system("rm", "-rf", version) or raise system('./system/fastly-purge-key', '--soft', "en/#{version}") @@ -24,5 +24,5 @@ def create_document(version) end VERSIONS.reverse_each do |version| - create_document(version) + download_document(version) end From 3aab1688dd96b9a2d3e27454a1ae4e596cfb0577 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Thu, 29 Feb 2024 12:15:38 +0900 Subject: [PATCH 05/50] Fix file path of tarball --- system/rdoc-static-all | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system/rdoc-static-all b/system/rdoc-static-all index b0d975f..4c666b4 100755 --- a/system/rdoc-static-all +++ b/system/rdoc-static-all @@ -16,7 +16,7 @@ def download_document(version) system("rm", "-rf", version, "ruby-docs-en-#{version}.tar.xz") or raise system("curl", "-sSLO", "https://cache.ruby-lang.org/pub/ruby/doc/ruby-docs-en-#{version}.tar.xz") or raise system("ls", "-l", "ruby-docs-en-#{version}.tar.xz") - system("tar", "xf", "https://cache.ruby-lang.org/pub/ruby/doc/ruby-docs-en-#{version}.tar.xz") or raise + system("tar", "xf", "ruby-docs-en-#{version}.tar.xz") or raise system("rsync", "-acvi", "--no-times", "--delete", version, DOC_ROOT) or raise system("rm", "-rf", version) or raise system('./system/fastly-purge-key', '--soft', "en/#{version}") From ee51e4b73186e75729cdb006392272bc37eed95f Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Thu, 29 Feb 2024 13:03:02 +0900 Subject: [PATCH 06/50] Remove unused Rakefile since be6b66c3e40ea9e2f912403db7899dea342cbcba --- Rakefile | 65 -------------------------------------------------------- 1 file changed, 65 deletions(-) delete mode 100644 Rakefile diff --git a/Rakefile b/Rakefile deleted file mode 100644 index 9d39354..0000000 --- a/Rakefile +++ /dev/null @@ -1,65 +0,0 @@ -require 'rdoc/task' - -versions = { - "master" => "master", - "3.3" => "ruby_3_3", - "3.2" => "ruby_3_2", - "3.1" => "ruby_3_1", - "3.0" => "ruby_3_0", -} - -def sh_with_unbundled_env(...) - Bundler.with_unbundled_env do - sh(...) - end -end - -versions.each do |version, branch_name| - source_dir = "sources/#{version}" - - directory source_dir do - sh "git clone --depth=1 --branch=#{branch_name} https://github.com/ruby/ruby #{source_dir}" - end - - desc "Checks out source for #{version}" - task "source:#{version}" => source_dir - - desc "Updates source for #{version}" - task "update:#{version}" => source_dir do - Dir.chdir source_dir do - sh "git fetch origin" - sh "git reset origin/#{branch_name} --hard" - end - end - - desc "Compile source for #{version}" - task "compile:#{version}" => source_dir do - Dir.chdir source_dir do - sh "autoconf && ./configure --disable-install-doc" unless File.exist?("Makefile") - sh_with_unbundled_env "make -j2" - end - end - - namespace :rdoc do - lang_version = File.join("en", version) - task lang_version => "compile:#{version}" do - sh_with_unbundled_env( - "make", "html", - "RDOCOPTS=--title=\"Documentation for Ruby #{version}\"" \ - "--main=README.md", - "HTMLOUT=#{Dir.pwd}/#{version}", - chdir: source_dir - ) - end - end - task "rdoc:#{version}" => ["update:#{version}", "compile:#{version}"] -end - -desc "Checks out sources for all versions" -task "source" => versions.keys.map { |version| "source:#{version}" } - -desc "Updates sources for all versions" -task "update" => versions.keys.map { |version| "update:#{version}" } - -desc "Build RDoc HTML files for all versions" -task "rdoc" => versions.keys.map { |version| "rdoc:#{version}" } From 174c868c4708bb1ab5490a01a20ac0b4449acac4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Mar 2024 20:41:09 +0000 Subject: [PATCH 07/50] Bump capistrano from 3.18.0 to 3.18.1 Bumps [capistrano](https://github.com/capistrano/capistrano) from 3.18.0 to 3.18.1. - [Release notes](https://github.com/capistrano/capistrano/releases) - [Commits](https://github.com/capistrano/capistrano/compare/v3.18.0...v3.18.1) --- updated-dependencies: - dependency-name: capistrano dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index f71c34d..d64b879 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,30 +1,35 @@ GEM remote: https://rubygems.org/ specs: - airbrussh (1.5.0) + airbrussh (1.5.1) sshkit (>= 1.6.1, != 1.7.0) bcrypt_pbkdf (1.1.0) - capistrano (3.18.0) + capistrano (3.18.1) airbrussh (>= 1.0.0) i18n rake (>= 10.0.0) sshkit (>= 1.9.0) capistrano-bundler (2.1.0) capistrano (~> 3.1) - concurrent-ruby (1.2.2) + concurrent-ruby (1.2.3) ed25519 (1.3.0) - i18n (1.14.1) + i18n (1.14.4) concurrent-ruby (~> 1.0) + mutex_m (0.2.0) net-scp (4.0.0) net-ssh (>= 2.6.5, < 8.0.0) - net-ssh (7.2.0) + net-sftp (4.0.0) + net-ssh (>= 5.0.0, < 8.0.0) + net-ssh (7.2.1) psych (5.1.1.1) stringio rake (13.1.0) rdoc (6.6.2) psych (>= 4.0.0) - sshkit (1.21.6) + sshkit (1.22.0) + mutex_m net-scp (>= 1.1.2) + net-sftp (>= 2.1.2) net-ssh (>= 2.8.0) stringio (3.1.0) From 631de4bcdb09eb1b1661270750ff42f621be049a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 25 Mar 2024 19:44:00 +0000 Subject: [PATCH 08/50] Bump rdoc from 6.6.2 to 6.6.3.1 Bumps [rdoc](https://github.com/ruby/rdoc) from 6.6.2 to 6.6.3.1. - [Release notes](https://github.com/ruby/rdoc/releases) - [Changelog](https://github.com/ruby/rdoc/blob/master/History.rdoc) - [Commits](https://github.com/ruby/rdoc/compare/v6.6.2...v6.6.3.1) --- updated-dependencies: - dependency-name: rdoc dependency-type: direct:production ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index d64b879..eeefbc0 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -21,10 +21,10 @@ GEM net-sftp (4.0.0) net-ssh (>= 5.0.0, < 8.0.0) net-ssh (7.2.1) - psych (5.1.1.1) + psych (5.1.2) stringio rake (13.1.0) - rdoc (6.6.2) + rdoc (6.6.3.1) psych (>= 4.0.0) sshkit (1.22.0) mutex_m From 9835b891cc56ead67220ad87164f3cfd6d01f700 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 May 2024 20:24:31 +0000 Subject: [PATCH 09/50] --- updated-dependencies: - dependency-name: bcrypt_pbkdf dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index eeefbc0..e9b20f2 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -3,7 +3,7 @@ GEM specs: airbrussh (1.5.1) sshkit (>= 1.6.1, != 1.7.0) - bcrypt_pbkdf (1.1.0) + bcrypt_pbkdf (1.1.1) capistrano (3.18.1) airbrussh (>= 1.0.0) i18n From d3815cf66a24ec8f7e8115d2cb49151aa268cc38 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 27 May 2024 20:40:21 +0000 Subject: [PATCH 10/50] Bump rdoc from 6.6.3.1 to 6.7.0 Bumps [rdoc](https://github.com/ruby/rdoc) from 6.6.3.1 to 6.7.0. - [Release notes](https://github.com/ruby/rdoc/releases) - [Changelog](https://github.com/ruby/rdoc/blob/master/History.rdoc) - [Commits](https://github.com/ruby/rdoc/compare/v6.6.3.1...v6.7.0) --- updated-dependencies: - dependency-name: rdoc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index e9b20f2..98bb3b5 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -24,7 +24,7 @@ GEM psych (5.1.2) stringio rake (13.1.0) - rdoc (6.6.3.1) + rdoc (6.7.0) psych (>= 4.0.0) sshkit (1.22.0) mutex_m From c6465e9e29e8651c82065acc7e41c162686ea913 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Thu, 6 Jun 2024 16:05:44 +0900 Subject: [PATCH 11/50] Use rurema/generated-documents instead of generating on docs --- provision/systemd/update-docs-ja.timer | 2 +- system/bc-setup-all | 21 +++++++++++++++++++++ system/bc-static-all | 8 ++++++++ 3 files changed, 30 insertions(+), 1 deletion(-) diff --git a/provision/systemd/update-docs-ja.timer b/provision/systemd/update-docs-ja.timer index 078e31a..29bf518 100644 --- a/provision/systemd/update-docs-ja.timer +++ b/provision/systemd/update-docs-ja.timer @@ -2,7 +2,7 @@ Description=Update docs.ruby-lang.org/ja/ [Timer] -OnCalendar=*-*-* 0:15 +OnCalendar=*-*-* 20:15 Persistent=true Unit=bc-setup-all.service diff --git a/system/bc-setup-all b/system/bc-setup-all index 2424cc0..65e89ea 100755 --- a/system/bc-setup-all +++ b/system/bc-setup-all @@ -19,6 +19,8 @@ BITCLUST_LIB_DIR = "#{BITCLUST_BASE}/lib" DOC_BASE = "/var/rubydoc/doctree" REF_BASE = "refm" # was "#{DOC_BASE}/refm" +GENERATED_DOCUMENTS_BASE = "/var/rubydoc/generated-documents" + def setup_db(version) Dir.chdir(DOC_BASE) do db = "#{REF_BASE}/db-#{version}" @@ -38,6 +40,25 @@ if !File.directory?(DOC_BASE) system(*%W"git clone --depth 1 https://github.com/rurema/doctree.git #{DOC_BASE}") end + +if !File.directory?(GENERATED_DOCUMENTS_BASE) + system(*%W"git clone --depth 1 https://github.com/rurema/generated-documents.git #{GENERATED_DOCUMENTS_BASE}") +end + +Dir.chdir(GENERATED_DOCUMENTS_BASE) do + system(*%w"git fetch origin") + system(*%w"git reset origin/main --hard") +end + +Dir.glob("#{GENERATED_DOCUMENTS_BASE}/db/db-*") do |db| + src = db + dst = "#{DOC_BASE}/"#{REF_BASE}/#{File.basename(db)}" + FileUtils.rm_rf(dst) if File.directory?(dst) + system(*%w"ln -snf #{src} #{dst}") +end + +exit + Dir.chdir(BITCLUST_BASE) do system(*%w"git fetch origin") system(*%w"git reset origin/master --hard") diff --git a/system/bc-static-all b/system/bc-static-all index fca8ac2..403f730 100755 --- a/system/bc-static-all +++ b/system/bc-static-all @@ -21,6 +21,14 @@ REF_BASE = "/var/rubydoc/doctree/refm" DOC_ROOT = "/var/www/docs.ruby-lang.org/shared/public/ja" +GENERATED_DOCUMENTS_BASE = "/var/rubydoc/generated-documents" + +Dir.glob("#{GENERATED_DOCUMENTS_BASE}/html/ja/*") do |version| + system("rsync", "-acvi", "--no-times", "--delete", version, DOC_ROOT) or raise +end + +exit + def create_document(version) system(RUBY, "-I#{BITCLUST_LIB_DIR}", BITCLUST, From 5b2dc8630e73d76daf4d5e31d522e3aed00ac70c Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Thu, 6 Jun 2024 16:16:40 +0900 Subject: [PATCH 12/50] Fix a typo --- system/bc-setup-all | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/system/bc-setup-all b/system/bc-setup-all index 65e89ea..cf7520a 100755 --- a/system/bc-setup-all +++ b/system/bc-setup-all @@ -40,7 +40,6 @@ if !File.directory?(DOC_BASE) system(*%W"git clone --depth 1 https://github.com/rurema/doctree.git #{DOC_BASE}") end - if !File.directory?(GENERATED_DOCUMENTS_BASE) system(*%W"git clone --depth 1 https://github.com/rurema/generated-documents.git #{GENERATED_DOCUMENTS_BASE}") end @@ -52,7 +51,7 @@ end Dir.glob("#{GENERATED_DOCUMENTS_BASE}/db/db-*") do |db| src = db - dst = "#{DOC_BASE}/"#{REF_BASE}/#{File.basename(db)}" + dst = "#{DOC_BASE}/#{REF_BASE}/#{File.basename(db)}" FileUtils.rm_rf(dst) if File.directory?(dst) system(*%w"ln -snf #{src} #{dst}") end From c693a809de3e92a5bed485ee4d785fad5141892b Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Thu, 6 Jun 2024 16:25:23 +0900 Subject: [PATCH 13/50] Fix a typo --- system/bc-setup-all | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/system/bc-setup-all b/system/bc-setup-all index cf7520a..6a6d87e 100755 --- a/system/bc-setup-all +++ b/system/bc-setup-all @@ -53,7 +53,7 @@ Dir.glob("#{GENERATED_DOCUMENTS_BASE}/db/db-*") do |db| src = db dst = "#{DOC_BASE}/#{REF_BASE}/#{File.basename(db)}" FileUtils.rm_rf(dst) if File.directory?(dst) - system(*%w"ln -snf #{src} #{dst}") + system(*%W"ln -snf #{src} #{dst}") end exit From 19962aec09b77895d3e441fd3d21854ee4ff7cbe Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Fri, 7 Jun 2024 11:17:56 +0900 Subject: [PATCH 14/50] Add WARNING and remove unused information --- README.md | 51 ++++++++------------------------------------------- 1 file changed, 8 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 109f8f2..5e27007 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # docs.ruby-lang.org +## WARNING + +* This repository is inconsistent with production. +* Use only `bundle exec cap production deploy`. Do not use `ansible-playbook`. + ## Platform Environment * We use `capistrano` for deployments. @@ -7,12 +12,6 @@ * All applications run as `rurema` user. * Periodic tasks run in systemd timer (`systemctl list-timers`) -### Requisites - -* Debian 10 (buster) - * `apt install nginx groonga git bundler certbot` -* passenger nginx module: https://www.phusionpassenger.com/docs/advanced_guides/install_and_upgrade/standalone/install/oss/buster.html - ## Files and Directories * rurema-search: `/var/rubydoc` @@ -22,40 +21,15 @@ ## Files need to backup * old statically generated contents (old versions need to copy from old server): `/var/www/docs.ruby-lang.org/shared/public/{en,ja}/*` + * Versioned contents of `ja` are from since 2024-06-06. * Fastly API Key: `/home/rurema/.docs-fastly` * Slack webhook URL: `/etc/systemd/system/notify-to-slack.env` +* Mackerel API Key and plugin configurations: `/etc/mackerel-agent/mackerel-agent.conf` ## Related repos * https://github.com/ruby/rurema-search - -## Vagrant Environment - -Usage: - -``` -git clone https://github.com/ruby/docs.ruby-lang.org -git clone https://github.com/ruby/rurema-search -cd docs.ruby-lang.org -vagrant up -vagrant ssh-config >> ~/.ssh/config -bundle install -cap vagrant deploy -cp config/deploy/vagrant.rb ../rurema-search/config/deploy/vagrant.rb -cd ../rurema-search -cap vagrant deploy -cd ../docs.ruby-lang.org -vagrant ssh -sudo systemctl start rdoc-static-all.service bc-setup-all.service & -sudo systemctl status rdoc-static-all.service bc-setup-all.service bc-static-all.service update-rurema-index.service -``` - -- Open `https://localhost:10443/` in browser (ignore certificate error (`NET::ERR_CERT_AUTHORITY_INVALID`) because of using self signed certificate generated by `provision/selfsigned.yml`) -- Run `sudo systemctl start rdoc-static-all.service` to update English documents. -- Run `sudo systemctl start bc-setup-all.service` to update Japanese documents. -- Run `sudo systemctl status rdoc-static-all.service bc-setup-all.service bc-static-all.service update-rurema-index.service` to see progress. - - `Active: activating (start) since ...` means running. - - `Active: inactive (dead) since ...` means finished. +* https://github.com/rurema/generated-documents ## Production Environment @@ -65,15 +39,6 @@ sudo systemctl status rdoc-static-all.service bc-setup-all.service bc-static-all cap production deploy ``` -### ansible - -``` -ansible-playbook -i docs-2020, provision/playbook.yml -ansible-playbook -i docs-2020, provision/users.yml -ansible-playbook -i docs-2020, provision/rurema-search.yml -ansible-playbook -i docs-2020, provision/letsencrypt.yml -``` - ### /etc/mackerel-agent/mackerel-agent.conf Install `mackerel-check-plugins` too. From 3834d047a4f76131755309327603cc49c2bc8271 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Mon, 10 Jun 2024 15:03:17 +0900 Subject: [PATCH 15/50] Update redirect directory from rurema-search --- conf/docs.ruby-lang.org | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/conf/docs.ruby-lang.org b/conf/docs.ruby-lang.org index bbc2b2b..b0518f3 100644 --- a/conf/docs.ruby-lang.org +++ b/conf/docs.ruby-lang.org @@ -88,9 +88,10 @@ return 301 https://docs.ruby-lang.org/$1/3.0$2; } - # links into /ja/3.1.0/ exist in rurema-search - location ~ ^/ja/3\.1\.0(.*) { - return 301 https://docs.ruby-lang.org/ja/3.1$1; + # This should update after release. + # links into /ja/3.4/ exist in rurema-search + location ~ ^/ja/3\.4(.*) { + return 302 https://docs.ruby-lang.org/ja/master$1; } location ~ ^/(en|ja)/(.+?)/ { From c1f79e3a0ef9716a37e3c22064342a896814c4e0 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Mon, 10 Jun 2024 18:24:21 +0900 Subject: [PATCH 16/50] Use ja/3.4 instead of redirect --- conf/docs.ruby-lang.org | 6 ------ config/deploy.rb | 2 +- 2 files changed, 1 insertion(+), 7 deletions(-) diff --git a/conf/docs.ruby-lang.org b/conf/docs.ruby-lang.org index b0518f3..3fb3955 100644 --- a/conf/docs.ruby-lang.org +++ b/conf/docs.ruby-lang.org @@ -88,12 +88,6 @@ return 301 https://docs.ruby-lang.org/$1/3.0$2; } - # This should update after release. - # links into /ja/3.4/ exist in rurema-search - location ~ ^/ja/3\.4(.*) { - return 302 https://docs.ruby-lang.org/ja/master$1; - } - location ~ ^/(en|ja)/(.+?)/ { add_header Cache-Control "public, max-age=43200, s-maxage=172800, stale-while-revalidate=86400, stale-if-error=604800"; add_header Surrogate-Key "docs $1 $2 $1/$2"; diff --git a/config/deploy.rb b/config/deploy.rb index 278e87a..0c7719b 100644 --- a/config/deploy.rb +++ b/config/deploy.rb @@ -12,4 +12,4 @@ 3.0 3.1 3.2 3.3 master ] -set :linked_dirs, ["sources", "public/ja/latest"] + versions.map{|v| ["public/en/#{v}", "public/ja/#{v}"]}.flatten +set :linked_dirs, ["sources", "public/ja/3.4", "public/ja/latest"] + versions.map{|v| ["public/en/#{v}", "public/ja/#{v}"]}.flatten From 98744e9c5033e95804ba35b09b414273c11c75da Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Fri, 28 Jun 2024 11:49:14 +0900 Subject: [PATCH 17/50] Add passenger_max_requests https://www.phusionpassenger.com/library/config/nginx/reference/#passenger_max_requests --- conf/docs.ruby-lang.org | 1 + 1 file changed, 1 insertion(+) diff --git a/conf/docs.ruby-lang.org b/conf/docs.ruby-lang.org index 3fb3955..44eb6d4 100644 --- a/conf/docs.ruby-lang.org +++ b/conf/docs.ruby-lang.org @@ -116,6 +116,7 @@ server_name localhost; root /var/rubydoc/rurema-search/current/public; passenger_enabled on; + passenger_max_requests 1000000; # add_header Cache-Control "private"; add_header Cache-Control "public, max-age=3600, s-maxage=172800, stale-while-revalidate=86400, stale-if-error=60"; From f8050de0c25a04866dd7d5e89a272a6affad1184 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 1 Jul 2024 20:11:55 +0000 Subject: [PATCH 18/50] Bump capistrano from 3.18.1 to 3.19.0 Bumps [capistrano](https://github.com/capistrano/capistrano) from 3.18.1 to 3.19.0. - [Release notes](https://github.com/capistrano/capistrano/releases) - [Commits](https://github.com/capistrano/capistrano/compare/v3.18.1...v3.19.0) --- updated-dependencies: - dependency-name: capistrano dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 98bb3b5..772a287 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,33 +1,33 @@ GEM remote: https://rubygems.org/ specs: - airbrussh (1.5.1) + airbrussh (1.5.2) sshkit (>= 1.6.1, != 1.7.0) + base64 (0.2.0) bcrypt_pbkdf (1.1.1) - capistrano (3.18.1) + capistrano (3.19.0) airbrussh (>= 1.0.0) i18n rake (>= 10.0.0) sshkit (>= 1.9.0) capistrano-bundler (2.1.0) capistrano (~> 3.1) - concurrent-ruby (1.2.3) + concurrent-ruby (1.3.3) ed25519 (1.3.0) - i18n (1.14.4) + i18n (1.14.5) concurrent-ruby (~> 1.0) - mutex_m (0.2.0) net-scp (4.0.0) net-ssh (>= 2.6.5, < 8.0.0) net-sftp (4.0.0) net-ssh (>= 5.0.0, < 8.0.0) - net-ssh (7.2.1) + net-ssh (7.2.3) psych (5.1.2) stringio - rake (13.1.0) + rake (13.2.1) rdoc (6.7.0) psych (>= 4.0.0) - sshkit (1.22.0) - mutex_m + sshkit (1.23.0) + base64 net-scp (>= 1.1.2) net-sftp (>= 2.1.2) net-ssh (>= 2.8.0) From ecfa9294c0c81f96f2dafc6f27a2b7b388db9552 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 8 Jul 2024 20:32:15 +0000 Subject: [PATCH 19/50] Bump capistrano from 3.19.0 to 3.19.1 Bumps [capistrano](https://github.com/capistrano/capistrano) from 3.19.0 to 3.19.1. - [Release notes](https://github.com/capistrano/capistrano/releases) - [Commits](https://github.com/capistrano/capistrano/compare/v3.19.0...v3.19.1) --- updated-dependencies: - dependency-name: capistrano dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 772a287..97136eb 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -5,7 +5,7 @@ GEM sshkit (>= 1.6.1, != 1.7.0) base64 (0.2.0) bcrypt_pbkdf (1.1.1) - capistrano (3.19.0) + capistrano (3.19.1) airbrussh (>= 1.0.0) i18n rake (>= 10.0.0) From 31777714bcf544c9a735a8931dd52af1208fcc7f Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Tue, 9 Jul 2024 08:27:41 +0900 Subject: [PATCH 20/50] Reduce passenger_max_requests --- conf/docs.ruby-lang.org | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf/docs.ruby-lang.org b/conf/docs.ruby-lang.org index 44eb6d4..5f6e4ef 100644 --- a/conf/docs.ruby-lang.org +++ b/conf/docs.ruby-lang.org @@ -116,7 +116,7 @@ server_name localhost; root /var/rubydoc/rurema-search/current/public; passenger_enabled on; - passenger_max_requests 1000000; + passenger_max_requests 500000; # add_header Cache-Control "private"; add_header Cache-Control "public, max-age=3600, s-maxage=172800, stale-while-revalidate=86400, stale-if-error=60"; From 80cdb679e6cf155725c1be6935b1cc361847ae78 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Fri, 26 Jul 2024 10:53:11 +0900 Subject: [PATCH 21/50] Add proxy_pass to doxygen-latest-html --- conf/docs.ruby-lang.org | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/conf/docs.ruby-lang.org b/conf/docs.ruby-lang.org index 5f6e4ef..daba2aa 100644 --- a/conf/docs.ruby-lang.org +++ b/conf/docs.ruby-lang.org @@ -94,6 +94,13 @@ } } + location /capi/en/master/ { + rewrite ^(.*)/$ $1/index.html; + proxy_pass https://rubyci.s3.amazonaws.com/doxygen-latest-html/; + add_header Cache-Control "public, max-age=43200, s-maxage=172800, stale-while-revalidate=86400, stale-if-error=604800"; + add_header Surrogate-Key "doxygen-latest-html"; + } + location /ja/search { proxy_pass http://localhost:9292; } From e6ed8a467827bad78b848926ffc2e7ca057c83e9 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Fri, 26 Jul 2024 10:55:31 +0900 Subject: [PATCH 22/50] Add a link to /capi/en/master/ --- public/index.html | 1 + 1 file changed, 1 insertion(+) diff --git a/public/index.html b/public/index.html index 1a670b1..8b41d99 100644 --- a/public/index.html +++ b/public/index.html @@ -21,6 +21,7 @@

docs.ruby-lang.org

English Documentation for Ruby (Generated by RDoc) + English Developers' documentation for Ruby (Generated by Doxygen) Japanese Ruby Reference Manual (プログラミング言語 Ruby リファレンスマニュアル)

From 2ab53720cd96047eeba29748931f7c82bfed6396 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Fri, 26 Jul 2024 11:01:37 +0900 Subject: [PATCH 23/50] Update about nginx conf --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e27007..060a9f9 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,17 @@ ## Production Environment -## Capstrano +### Capstrano ``` cap production deploy ``` +### /etc/nginx/sites-available/docs.ruby-lang.org + +Manual sync with `conf/docs.ruby-lang.org`. +Because ansible playbooks are outdated. + ### /etc/mackerel-agent/mackerel-agent.conf Install `mackerel-check-plugins` too. From f0eb4d0ef01c81d4f2476393a5ffd169be9a10bd Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 12 Aug 2024 20:05:03 +0000 Subject: [PATCH 24/50] Bump capistrano-bundler from 2.1.0 to 2.1.1 Bumps [capistrano-bundler](https://github.com/capistrano/bundler) from 2.1.0 to 2.1.1. - [Release notes](https://github.com/capistrano/bundler/releases) - [Commits](https://github.com/capistrano/bundler/compare/v2.1.0...v2.1.1) --- updated-dependencies: - dependency-name: capistrano-bundler dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 97136eb..02a0328 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -10,9 +10,9 @@ GEM i18n rake (>= 10.0.0) sshkit (>= 1.9.0) - capistrano-bundler (2.1.0) + capistrano-bundler (2.1.1) capistrano (~> 3.1) - concurrent-ruby (1.3.3) + concurrent-ruby (1.3.4) ed25519 (1.3.0) i18n (1.14.5) concurrent-ruby (~> 1.0) From 566599711b55e4b4692b79f1aee822c9111a5db8 Mon Sep 17 00:00:00 2001 From: Thomas Marshall Date: Mon, 7 Oct 2024 12:18:10 +0100 Subject: [PATCH 25/50] Add favicon.ico --- public/favicon.ico | Bin 0 -> 8348 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 public/favicon.ico diff --git a/public/favicon.ico b/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..4a8e9e91e14afe6ad76987724f3cd0a4f5d53a85 GIT binary patch literal 8348 zcmeHLd3;snnf~r}?tbpM=Wbbm1PDY{0hNk_h^?jCO514_bo^D3cIu4IFenh>3Z5E`$M|II@Doc9m$8Gj-M67u;!^08}azjA0(D(&7$2d(bu z=ltgK&vaYyVTU7cyTz5c)~cmfJM?JoMa5n#@!esYk&U0$HaB5j_c&EUkcn7zUiQ&1j?ugvMz zW5eYB{f@rhHnB9OMLvf%JK3d`!Kr2v>2MH=xeN|d8Tsc!wa$Unnh#-}1)*dS=`h+p zhT@(Imv=T)y%-)}33UGg1Vc*^6TJp;Z8stzemA-#9KpkhXYpu{D|o8!9sH>O9mI8M zL`*{YV9D=x7yIm<-0Lp22u?TkcW1-xnG4NR3y*s-`AeaZ-)=2{(V9aU$ZySnuzXA; zL$Rj8>t2K?y$&({dbAB~M11r%B(&Lu#CH48rTsy4?|1}#D8s{v$KecS!%RHh=fo?L z-{H+0?9}JOr53{NE`-ySkErOCh-uS+sF*s0+||&PIdEDFVY23uJDZq68<1a_NEyaO zOua1!XPCf4r zPG2e9>KwS8MezA5(W&cBbWGfa4vE{*HhMLDmbr|9BF4aMa?kvRKaKoTiBw_&Wf;rv zr^Dk~L^)~^)K?%nuoiKl&4`Iw1;zq|H<=g*Uu+E?>vB0cqQ749k>poZa@gmRcN2O& zeiYsM>_^w$`;pjf7lO7js7mqu7?3_tG70LVOe3TWlOi&hloYre74*qc1hf_K>Xk6* zDKO|0VB}Tu2V+;GXNNOcl3$Ho^R_ck1(&m!GB3iQ!N>8;^CvN2&~ZHR!(({-=@V$@ zuYqbR{3ZsZ52PLL$6~WDCQ}CKk1;SqCsM$CpbX572!C?Kuk=Z&W7OiA$h@3F8B$@6@K27|Arz`Z`_PURlD~cT9Yfl5-HWK$#mFzX zi1`&?AS>rGQqwLWY2pQZIQ|lb|L!Qf<`Ot8h2Q8dxfutFjKk?fT9|o38nc^QWWYaWDc4pB-}5amQ!GpvjW%V_@QBUofTBh2Ktc&9>B zYoU8;4+)WE>^_kk*2H3n6aO&Ck^$X?Lvh@sZ-M)wZPd8GA#c&2{;qcWE zOCzxBOK=}GP}F&0VUhgIONBXS9!;6XL-8>VT+?AOmB6OVyWw=!L{YV_SFYa0`(uvd z>1TJLQ;!Bj$5+Co)7B=g6{ER+5=M?%hYO#7g%@7l#s8TPp;d5)RyHHZYj8ybYG^g< zav}L;K1fIzWQ`gFGvm?ZV7!XiFdAovt=6*6r4I~pC0`Ri4Si?ux$mo8DAF3&G@nLw@&7mn{{7f&YNe# z6)Hk;`4LP_Ka1{tKfz;95d%KKBmH*}JJI!##<0PbO@5h|Ej5yQMD$6bP5EBxFGLZM zGl=|#>(}ose&(l}VYa2QcF^Wh<_I@y4Eupli^)G1!at9)@ZMH{$r<}lT6qo65BU`T z{4dRT@zvw#J77bTFv=d)QX6D_ly;EzAh$9e!od6yB}DE^G6yL`&k^s`-xFdi*U?|n z-VWxsyM=o`gwEWGfcfR29IS`QQ}<%ymap*NyGA`DI!kWydaH-{OFe(S-0;n2baUhc}VfFE~>1Bt_3hU$~iky7xu(Ry^h$0@oD%| z?SuUCo-({XI`ueZV}9!NUkksqc|`9P?xo}>RC(nyQH6>>pTqA*>}C8eWuCG|25VsV zFNIBC425eg5t$a#KH2w#18 z-(&b}c+@)^OHZ1vQ4XF?t1@q2*yk&Aw-}zTIR{-r@U4 z9QZbV`Rv5$FaP7YA)DzZ$4E@)`NS}EL1D`*PeuMT?mV-#>y{XCR%e!Y&Cx@--#IWK@ z3Y#5CoMlE``aXX7-Iuq%{`Fgb{L39-r|o5rmvJwB&K_>iR+4)S=eo7zU(06==-h7) zPMo}h+SNBuzVH@aer?}fw?FruUCRtR^{g=WSd<}!GH@1gBpv_1_~rME$>$16&fRL; zsV)-hLS+nj$?si7Zt|1c6ySIICg>0C!OdG?G&MDaXXWm>>(VlttnL})o=Ief9p3b? z-7_g{(hh~uya*3;JXxkkGO*1;5PfGKJd{l6W(o;kvw z0%OMSVjav03+Ft}U?rRh@?cXlVDqF9A8}q7OT0DYyZFBCIbZ81-YBcSxb7D(?Q3e= z^Dy)C6Z&NfV`Mul!F`xhaSgT0FXLyw+zWqf9Sm+6FAG=;ieOcuC8_r3f7^Bv_-h@TVh+`e&d*zEkzU;W*i$6oFB=#I`fB`YION{cWl*2y~B#((cSBR760g_f$}WC;mgl*`)6^cEP%~c35RR%mw|TOPWHEIb1yjk3(@|cK1EzV?k89i&5pc? z4AdjC-r}AFt1A5yjMKacqYMFm*){SUlFvZ4a0i<_|U#BJ8z((<_c=+uVK}OFX4+}PvW_P z$x{NOS_%W>)S#C0d?S_fH}?wMJ1J@b?CzR(%NAeV_WO5_AeguU{&rayF|w9(&+dpG zM%I6Y^SGi*RB+8y+LO9)-Zyd%GMkGhEMIqJqo@6Ho{w-Qba2KpPDMhWGQ2o^I}#q- z3O!*x0-ZOoM^wByu{GuiK^!)zy?m|em6^z?qR@TA-?%e97J2|@k6rEmlmAT94C zmegH?&Ci}^=RVV25V5JEa_?-&TFvkj%h#OxH{s$e<74auXs-bKI@b#ND=KjrN*A19 zZQ@+!n$Ns1<~wpZ^QXgPo4!r1rwrEj$M38Y7IOII+DaJw)r6d57U8METha4L)-mrg zSOPULvv(`rd^kPh4$JlO!*^(}|JT-)!YpT#s>oV{ZwasLuW{=!@Pz}=yX}B4aSNPL z3mDTp575V4XkOj?m+x?nO5VFrI62R;uNVR=VTx{`JvZTl)C?`R_7dYc&BD~y(yjt*REzoL#RtvORpw$Ac77*gEkfCZ) literal 0 HcmV?d00001 From 3b524faa71a71b7b57221ba9d1d9fbd77ab3fc76 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Nov 2024 20:29:22 +0000 Subject: [PATCH 26/50] Bump capistrano from 3.19.1 to 3.19.2 Bumps [capistrano](https://github.com/capistrano/capistrano) from 3.19.1 to 3.19.2. - [Release notes](https://github.com/capistrano/capistrano/releases) - [Commits](https://github.com/capistrano/capistrano/compare/v3.19.1...v3.19.2) --- updated-dependencies: - dependency-name: capistrano dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 02a0328..2a13da1 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,11 +1,11 @@ GEM remote: https://rubygems.org/ specs: - airbrussh (1.5.2) + airbrussh (1.5.3) sshkit (>= 1.6.1, != 1.7.0) base64 (0.2.0) bcrypt_pbkdf (1.1.1) - capistrano (3.19.1) + capistrano (3.19.2) airbrussh (>= 1.0.0) i18n rake (>= 10.0.0) @@ -14,23 +14,25 @@ GEM capistrano (~> 3.1) concurrent-ruby (1.3.4) ed25519 (1.3.0) - i18n (1.14.5) + i18n (1.14.6) concurrent-ruby (~> 1.0) net-scp (4.0.0) net-ssh (>= 2.6.5, < 8.0.0) net-sftp (4.0.0) net-ssh (>= 5.0.0, < 8.0.0) - net-ssh (7.2.3) + net-ssh (7.3.0) + ostruct (0.6.1) psych (5.1.2) stringio rake (13.2.1) rdoc (6.7.0) psych (>= 4.0.0) - sshkit (1.23.0) + sshkit (1.23.2) base64 net-scp (>= 1.1.2) net-sftp (>= 2.1.2) net-ssh (>= 2.8.0) + ostruct stringio (3.1.0) PLATFORMS From 2cad8ca78d9b58b13de0e718fcdc69800361d327 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Thu, 14 Nov 2024 17:30:08 -0600 Subject: [PATCH 27/50] Add CONTRIBUTING.md to outline the documentation generation pipeline Co-authored-by: Jeremy Hinegardner --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..93cc45f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +## How docs.ruby-lang.org/en Works + +### Overview + +The English Ruby documentation is automatically generated and updated through a pipeline involving GitHub Actions, AWS S3, and systemd services. Here's how it all comes together: + +1. **Documentation Generation and Upload** + + - A scheduled [GitHub Action](https://github.com/ruby/actions/blob/master/.github/workflows/docs.yml) generates the documentation for all [actively maintained Ruby versions](https://www.ruby-lang.org/en/downloads/branches/) plus the master branch. Each documentation set is generated using the version of RDoc bundled with that specific Ruby version. + - *Example:* For [Ruby 3.3](https://docs.ruby-lang.org/en/3.3/), the documentation is generated with RDoc 6.6.3.1. + - The generated docs are uploaded as `ruby-docs-en-.tar.xz` to the `ftp.r-l.o/pub/ruby/doc/` S3 bucket. + - You can find these uploads at [cache.ruby-lang.org/pub/ruby/doc/](https://cache.ruby.org/pub/ruby/doc/), which is powered by [cache.r-l.o](https://github.com/ruby/cache.r-l.o). + +2. **Website Update** + + - On the server running this application, the `update-docs-en.timer` systemd timer triggers the `rdoc-static-all` service at scheduled intervals. + - Timer definition: [update-docs-en.timer](https://github.com/ruby/docs.ruby-lang.org/blob/master/provision/systemd/update-docs-en.timer) + - Service definition: [rdoc-static-all.service](https://github.com/ruby/docs.ruby-lang.org/blob/master/provision/systemd/rdoc-static-all.service) + - The `rdoc-static-all` service runs the [rdoc-static-all](https://github.com/ruby/docs.ruby-lang.org/blob/master/system/rdoc-static-all) script. + - This script downloads the latest documentation from S3 and updates the website accordingly. From 095388760a3f22cb1ec1de4589c604ac22861c21 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 25 Nov 2024 21:16:34 +0000 Subject: [PATCH 28/50] Bump rdoc from 6.7.0 to 6.8.1 Bumps [rdoc](https://github.com/ruby/rdoc) from 6.7.0 to 6.8.1. - [Release notes](https://github.com/ruby/rdoc/releases) - [Changelog](https://github.com/ruby/rdoc/blob/master/History.rdoc) - [Commits](https://github.com/ruby/rdoc/compare/v6.7.0...v6.8.1) --- updated-dependencies: - dependency-name: rdoc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 2a13da1..8438f24 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -22,10 +22,10 @@ GEM net-ssh (>= 5.0.0, < 8.0.0) net-ssh (7.3.0) ostruct (0.6.1) - psych (5.1.2) + psych (5.2.0) stringio rake (13.2.1) - rdoc (6.7.0) + rdoc (6.8.1) psych (>= 4.0.0) sshkit (1.23.2) base64 @@ -33,7 +33,7 @@ GEM net-sftp (>= 2.1.2) net-ssh (>= 2.8.0) ostruct - stringio (3.1.0) + stringio (3.1.2) PLATFORMS ruby From dc0e64d8492222fbff770d7707f195c6c95121a2 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 1 Dec 2024 12:14:40 +0000 Subject: [PATCH 29/50] Add `bin/server` for previewing `public` directory locally --- Gemfile | 3 +++ Gemfile.lock | 5 +++++ README.md | 9 +++++++++ bin/server | 6 ++++++ 4 files changed, 23 insertions(+) create mode 100755 bin/server diff --git a/Gemfile b/Gemfile index 12d280a..af379c3 100644 --- a/Gemfile +++ b/Gemfile @@ -7,3 +7,6 @@ gem 'capistrano-bundler' # ed25519 gem 'ed25519' gem 'bcrypt_pbkdf' + +# For previewing public directory locally with `bin/server` +gem 'webrick' diff --git a/Gemfile.lock b/Gemfile.lock index 8438f24..330b3f1 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -34,6 +34,7 @@ GEM net-ssh (>= 2.8.0) ostruct stringio (3.1.2) + webrick (1.8.2) PLATFORMS ruby @@ -44,3 +45,7 @@ DEPENDENCIES capistrano-bundler ed25519 rdoc (>= 6.0.0.beta2) + webrick + +BUNDLED WITH + 2.5.17 diff --git a/README.md b/README.md index 060a9f9..6cdff93 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,15 @@ * https://github.com/ruby/rurema-search * https://github.com/rurema/generated-documents +## Previewing `public` directory locally + +1. Install dependencies: `bundle install` +2. Run: + ``` + bin/server + ``` +3. Open http://localhost:8000/ + ## Production Environment ### Capstrano diff --git a/bin/server b/bin/server new file mode 100755 index 0000000..a14c031 --- /dev/null +++ b/bin/server @@ -0,0 +1,6 @@ +#!/usr/bin/env ruby + +require "webrick" + +server = WEBrick::HTTPServer.new(Port: 8000, DocumentRoot: 'public') +server.start From 02ce3f437a297de7c83fc7a0d11602241f5f98e7 Mon Sep 17 00:00:00 2001 From: Martin Emde Date: Sat, 30 Nov 2024 12:35:06 -0800 Subject: [PATCH 30/50] Split the versions into supported/unsupported This makes the site more similar to the JA version. --- public/en/index.html | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/public/en/index.html b/public/en/index.html index 802ada1..d92c591 100644 --- a/public/en/index.html +++ b/public/en/index.html @@ -24,15 +24,17 @@

Documentation for Ruby

Ruby 3.3 Ruby 3.2 Ruby 3.1 - Ruby 3.0 - Ruby 2.7.0 - Ruby 2.6.0 (outdated) - Ruby 2.5.0 (outdated) - Ruby 2.4.0 (outdated) - Ruby 2.3.0 (outdated) - Ruby 2.2.0 (outdated) - Ruby 2.1.0 (outdated) - Ruby 2.0.0 (outdated) +

Ruby master From 7e3637961ce27c2674be8c0152745ca8ad0d4880 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Wed, 25 Dec 2024 17:45:14 +0900 Subject: [PATCH 32/50] Add 3.4 and update ja --- public/en/index.html | 1 + public/ja/index.html | 19 +++++++++++-------- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/public/en/index.html b/public/en/index.html index c6a5986..eebd9e5 100644 --- a/public/en/index.html +++ b/public/en/index.html @@ -21,6 +21,7 @@

Ruby Programming Language Documentation

Ruby master + Ruby 3.4 Ruby 3.3 Ruby 3.2 Ruby 3.1 diff --git a/public/ja/index.html b/public/ja/index.html index 9f09739..3d55a66 100644 --- a/public/ja/index.html +++ b/public/ja/index.html @@ -24,26 +24,29 @@

プログラミング言語 Ruby リファレンスマニュアル

常に最新のバージョンのドキュメントを参照したい場合は上のリンク先が使えます。

+ Ruby 3.4 Ruby 3.3 Ruby 3.2 Ruby 3.1 - Ruby 3.0 + るりまサーチ (全文検索)

Other versions

Project Page

From 2489ffed46ff00e6e01bb24d33313a48ed7adf13 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Wed, 25 Dec 2024 17:06:38 +0000 Subject: [PATCH 33/50] Add 3.4 to rdoc-static-all's list --- system/rdoc-static-all | 1 + 1 file changed, 1 insertion(+) diff --git a/system/rdoc-static-all b/system/rdoc-static-all index 4c666b4..dceaacb 100755 --- a/system/rdoc-static-all +++ b/system/rdoc-static-all @@ -5,6 +5,7 @@ VERSIONS = %w[ 3.1 3.2 3.3 + 3.4 master ] From 6335404c1e140a9aed10746f2f40d0d14a3f7594 Mon Sep 17 00:00:00 2001 From: Hiroshi SHIBATA Date: Thu, 26 Dec 2024 11:37:15 +0900 Subject: [PATCH 34/50] Ruby 3.4 is available now --- config/deploy.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config/deploy.rb b/config/deploy.rb index 0c7719b..f945731 100644 --- a/config/deploy.rb +++ b/config/deploy.rb @@ -9,7 +9,7 @@ versions = %w[ 1.8.7 1.9.3 2.0.0 2.1.0 2.2.0 2.3.0 2.4.0 2.5.0 2.6.0 2.7.0 - 3.0 3.1 3.2 3.3 + 3.0 3.1 3.2 3.3 3.4 master ] -set :linked_dirs, ["sources", "public/ja/3.4", "public/ja/latest"] + versions.map{|v| ["public/en/#{v}", "public/ja/#{v}"]}.flatten +set :linked_dirs, ["sources", "public/ja/3.5", "public/ja/latest"] + versions.map{|v| ["public/en/#{v}", "public/ja/#{v}"]}.flatten From 1b4818e0ad593f207380759fe78ccb159220b373 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 13 Jan 2025 20:10:33 +0000 Subject: [PATCH 35/50] Bump webrick from 1.8.2 to 1.9.1 Bumps [webrick](https://github.com/ruby/webrick) from 1.8.2 to 1.9.1. - [Release notes](https://github.com/ruby/webrick/releases) - [Commits](https://github.com/ruby/webrick/compare/v1.8.2...v1.9.1) --- updated-dependencies: - dependency-name: webrick dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 330b3f1..6688f7c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -34,7 +34,7 @@ GEM net-ssh (>= 2.8.0) ostruct stringio (3.1.2) - webrick (1.8.2) + webrick (1.9.1) PLATFORMS ruby From 4ee3e9e0d35077eb2a3940cd934950f7fd6cfe45 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 13 Jan 2025 20:10:42 +0000 Subject: [PATCH 36/50] Bump rdoc from 6.8.1 to 6.10.0 Bumps [rdoc](https://github.com/ruby/rdoc) from 6.8.1 to 6.10.0. - [Release notes](https://github.com/ruby/rdoc/releases) - [Changelog](https://github.com/ruby/rdoc/blob/master/History.rdoc) - [Commits](https://github.com/ruby/rdoc/compare/v6.8.1...v6.10.0) --- updated-dependencies: - dependency-name: rdoc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 330b3f1..6fc7cb2 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -13,6 +13,7 @@ GEM capistrano-bundler (2.1.1) capistrano (~> 3.1) concurrent-ruby (1.3.4) + date (3.4.1) ed25519 (1.3.0) i18n (1.14.6) concurrent-ruby (~> 1.0) @@ -22,10 +23,11 @@ GEM net-ssh (>= 5.0.0, < 8.0.0) net-ssh (7.3.0) ostruct (0.6.1) - psych (5.2.0) + psych (5.2.2) + date stringio rake (13.2.1) - rdoc (6.8.1) + rdoc (6.10.0) psych (>= 4.0.0) sshkit (1.23.2) base64 From e51e63d3177701aa2c6e8a0b5a4ddeceff33e87a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Jan 2025 20:47:34 +0000 Subject: [PATCH 37/50] Bump rdoc from 6.10.0 to 6.11.0 Bumps [rdoc](https://github.com/ruby/rdoc) from 6.10.0 to 6.11.0. - [Release notes](https://github.com/ruby/rdoc/releases) - [Changelog](https://github.com/ruby/rdoc/blob/master/History.rdoc) - [Commits](https://github.com/ruby/rdoc/compare/v6.10.0...v6.11.0) --- updated-dependencies: - dependency-name: rdoc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 9856449..ff90b72 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -23,11 +23,11 @@ GEM net-ssh (>= 5.0.0, < 8.0.0) net-ssh (7.3.0) ostruct (0.6.1) - psych (5.2.2) + psych (5.2.3) date stringio rake (13.2.1) - rdoc (6.10.0) + rdoc (6.11.0) psych (>= 4.0.0) sshkit (1.23.2) base64 From 56fc919c391c5345c46ae2efd7a761f41bef700e Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Tue, 28 Jan 2025 09:21:13 +0900 Subject: [PATCH 38/50] Reduce passenger_max_requests --- conf/docs.ruby-lang.org | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf/docs.ruby-lang.org b/conf/docs.ruby-lang.org index daba2aa..7a41949 100644 --- a/conf/docs.ruby-lang.org +++ b/conf/docs.ruby-lang.org @@ -123,7 +123,7 @@ server_name localhost; root /var/rubydoc/rurema-search/current/public; passenger_enabled on; - passenger_max_requests 500000; + passenger_max_requests 50000; # add_header Cache-Control "private"; add_header Cache-Control "public, max-age=3600, s-maxage=172800, stale-while-revalidate=86400, stale-if-error=60"; From 66221e6b3a6b1f609a4e4bd13f9099cc527cbeb7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 10 Feb 2025 20:26:44 +0000 Subject: [PATCH 39/50] Bump rdoc from 6.11.0 to 6.12.0 Bumps [rdoc](https://github.com/ruby/rdoc) from 6.11.0 to 6.12.0. - [Release notes](https://github.com/ruby/rdoc/releases) - [Changelog](https://github.com/ruby/rdoc/blob/master/History.rdoc) - [Commits](https://github.com/ruby/rdoc/compare/v6.11.0...v6.12.0) --- updated-dependencies: - dependency-name: rdoc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index ff90b72..141d540 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -27,7 +27,7 @@ GEM date stringio rake (13.2.1) - rdoc (6.11.0) + rdoc (6.12.0) psych (>= 4.0.0) sshkit (1.23.2) base64 From 2f82e0a2a045525ddbf2c468cb5a260bd37152ed Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Mon, 10 Mar 2025 10:36:38 +0900 Subject: [PATCH 40/50] Add real_ip_header and limit_req --- conf/docs.ruby-lang.org | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/conf/docs.ruby-lang.org b/conf/docs.ruby-lang.org index 7a41949..192952d 100644 --- a/conf/docs.ruby-lang.org +++ b/conf/docs.ruby-lang.org @@ -1,3 +1,7 @@ + # define limit zone + #limit_req_zone $binary_remote_addr zone=search_limit:10m rate=1r/s; + limit_req_zone global zone=search_limit:10m rate=2r/s; + server { listen 80; server_name doc.ruby-lang.org; @@ -63,6 +67,12 @@ proxy_set_header X-Forwarded-Proto https; proxy_set_header X-Forwarded-Port 443; + # generated by + # curl -fsSL https://api.fastly.com/public-ip-list | jq -r '.addresses+.ipv6_addresses|map("set_real_ip_from "+.+";")|join("\n")' > set_real_ip_from.conf + include /etc/nginx/set_real_ip_from.conf; + real_ip_header Fastly-Client-IP; + real_ip_recursive on; + location / { root /var/www/docs.ruby-lang.org/current/public; index index.html; @@ -102,6 +112,8 @@ } location /ja/search { + limit_req zone=search_limit burst=1 nodelay; + limit_req_status 429; proxy_pass http://localhost:9292; } From 2c5e5e87b6c294aa08461df9e5c96b1db4f3fd64 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Mon, 10 Mar 2025 10:41:06 +0900 Subject: [PATCH 41/50] Relax plugin.checks.fileage-update-rurema-index warning age --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6cdff93..fe82d1f 100644 --- a/README.md +++ b/README.md @@ -70,5 +70,5 @@ command = ["check-file-age", "-i", "-w", "90000", "-c", "172800", "-f", "/run/do [plugin.checks.fileage-rdoc-static-all] command = ["check-file-age", "-i", "-w", "90000", "-c", "172800", "-f", "/run/docs.ruby-lang.org/rdoc-static-all.updated"] [plugin.checks.fileage-update-rurema-index] -command = ["check-file-age", "-i", "-w", "90000", "-c", "172800", "-f", "/run/docs.ruby-lang.org/update-rurema-index.updated"] +command = ["check-file-age", "-i", "-w", "90060", "-c", "172800", "-f", "/run/docs.ruby-lang.org/update-rurema-index.updated"] ``` From 39cca3231d0220629a2343e43b2fe77ffa2a4fe7 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Mon, 10 Mar 2025 10:54:19 +0900 Subject: [PATCH 42/50] Set passenger_max_pool_size at http context MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PassengerでRroongaを使ったWebアプリケーションを動かすときにチューニングのコツ - 2014-08-26 - ククログ https://www.clear-code.com/blog/2014/8/26.html > PassengerでRroongaを使ったWebアプリケーションを動かすときのチューニングのコツを紹介しました。ポイントはpassenger_max_pool_sizeです。まずは、CPU数と同じにして様子を見てみてください。メモリー使用量が大きくなるようならCPU数よりも少なくしましょう。 https://www.phusionpassenger.com/library/config/nginx/reference/#passenger_max_pool_size > Context http --- conf/docs.ruby-lang.org | 2 ++ 1 file changed, 2 insertions(+) diff --git a/conf/docs.ruby-lang.org b/conf/docs.ruby-lang.org index 192952d..59cfd65 100644 --- a/conf/docs.ruby-lang.org +++ b/conf/docs.ruby-lang.org @@ -2,6 +2,8 @@ #limit_req_zone $binary_remote_addr zone=search_limit:10m rate=1r/s; limit_req_zone global zone=search_limit:10m rate=2r/s; + passenger_max_pool_size 2; + server { listen 80; server_name doc.ruby-lang.org; From 84eadee3bcadeeee6fa4688e32c79376b8c1ec0a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 24 Mar 2025 21:03:13 +0000 Subject: [PATCH 43/50] Bump rdoc from 6.12.0 to 6.13.0 Bumps [rdoc](https://github.com/ruby/rdoc) from 6.12.0 to 6.13.0. - [Release notes](https://github.com/ruby/rdoc/releases) - [Changelog](https://github.com/ruby/rdoc/blob/master/History.rdoc) - [Commits](https://github.com/ruby/rdoc/compare/v6.12.0...v6.13.0) --- updated-dependencies: - dependency-name: rdoc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 141d540..7272d7d 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -27,7 +27,7 @@ GEM date stringio rake (13.2.1) - rdoc (6.12.0) + rdoc (6.13.0) psych (>= 4.0.0) sshkit (1.23.2) base64 @@ -35,7 +35,7 @@ GEM net-sftp (>= 2.1.2) net-ssh (>= 2.8.0) ostruct - stringio (3.1.2) + stringio (3.1.5) webrick (1.9.1) PLATFORMS From 9e65a6662b01c1ac3d8ac5d3ce2cdb505587d1c4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 31 Mar 2025 20:52:08 +0000 Subject: [PATCH 44/50] Bump rdoc from 6.13.0 to 6.13.1 Bumps [rdoc](https://github.com/ruby/rdoc) from 6.13.0 to 6.13.1. - [Release notes](https://github.com/ruby/rdoc/releases) - [Changelog](https://github.com/ruby/rdoc/blob/master/History.rdoc) - [Commits](https://github.com/ruby/rdoc/compare/v6.13.0...v6.13.1) --- updated-dependencies: - dependency-name: rdoc dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 7272d7d..839a18c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -27,7 +27,7 @@ GEM date stringio rake (13.2.1) - rdoc (6.13.0) + rdoc (6.13.1) psych (>= 4.0.0) sshkit (1.23.2) base64 @@ -35,7 +35,7 @@ GEM net-sftp (>= 2.1.2) net-ssh (>= 2.8.0) ostruct - stringio (3.1.5) + stringio (3.1.6) webrick (1.9.1) PLATFORMS From d1aaca79949ca1030e0efe4de29c519787c63321 Mon Sep 17 00:00:00 2001 From: Kazuhiro NISHIYAMA Date: Thu, 3 Apr 2025 09:20:09 +0900 Subject: [PATCH 45/50] Ruby 3.1 is EOL --- public/en/index.html | 2 +- public/ja/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/public/en/index.html b/public/en/index.html index eebd9e5..02f2119 100644 --- a/public/en/index.html +++ b/public/en/index.html @@ -24,10 +24,10 @@

Ruby Programming Language Documentation

Ruby 3.4 Ruby 3.3 Ruby 3.2 - Ruby 3.1