rabbit-slide-znz-docs-r-l-o-ja-202406 2024.6.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.rabbit +2 -0
- data/README.md +23 -0
- data/README.md~ +24 -0
- data/Rakefile +17 -0
- data/config.yaml +24 -0
- data/docs-ruby-lang-org-ja.md +141 -0
- data/pdf/docs-r-l-o-ja-202406-docs-ruby-lang-org-ja.pdf +0 -0
- metadata +64 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ec77d5bf3f3ad9ec498dfa6063933df0363c0ea8d270a0072e7f89ab50dee726
|
4
|
+
data.tar.gz: '0183634f023d18f04c51389e44e72ee699c94003e4c3102af4e0ec847a560949'
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: acc45aef608d0a3b55f6d3b4af5b5269d6b8923ec976ae69e0110f962e7def2ef3f8ade0cea52636ab7e5e9aa562427285696fc9d3ec545f63ffdd20bd24049b
|
7
|
+
data.tar.gz: 4bca7904fa2c000397f920b58f8a0d8432f59d34f3e53b880a3ff63fe295753c9e757408df469a12ea471c1335dc0663fab7695d59d7c3cdf8808473fc02faa4
|
data/.rabbit
ADDED
data/README.md
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# docs.ruby-lang.org/ja/ の生成方法を変えた
|
2
|
+
|
3
|
+
[【大阪オフライン開催】RubyKaigi 2024 KaigiEffect発表会](https://kyobashirb.connpass.com/event/320687/) の発表資料です。
|
4
|
+
|
5
|
+
## 作者向け
|
6
|
+
|
7
|
+
### 表示
|
8
|
+
|
9
|
+
rake
|
10
|
+
|
11
|
+
### 公開
|
12
|
+
|
13
|
+
rake publish
|
14
|
+
|
15
|
+
## 閲覧者向け
|
16
|
+
|
17
|
+
### インストール
|
18
|
+
|
19
|
+
gem install rabbit-slide-znz-docs-r-l-o-ja-202406
|
20
|
+
|
21
|
+
### 表示
|
22
|
+
|
23
|
+
rabbit rabbit-slide-znz-docs-r-l-o-ja-202406.gem
|
data/README.md~
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# docs.ruby-lang.org/ja/ の生成方法を変えた
|
2
|
+
|
3
|
+
TODO: スライドの説明
|
4
|
+
|
5
|
+
## 作者向け
|
6
|
+
|
7
|
+
### 表示
|
8
|
+
|
9
|
+
rake
|
10
|
+
|
11
|
+
### 公開
|
12
|
+
|
13
|
+
rake publish
|
14
|
+
|
15
|
+
## 閲覧者向け
|
16
|
+
|
17
|
+
### インストール
|
18
|
+
|
19
|
+
gem install rabbit-slide-znz-docs-r-l-o-ja-202406
|
20
|
+
|
21
|
+
### 表示
|
22
|
+
|
23
|
+
rabbit rabbit-slide-znz-docs-r-l-o-ja-202406.gem
|
24
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
require "rabbit/task/slide"
|
2
|
+
|
3
|
+
# Edit ./config.yaml to customize meta data
|
4
|
+
|
5
|
+
spec = nil
|
6
|
+
Rabbit::Task::Slide.new do |task|
|
7
|
+
spec = task.spec
|
8
|
+
# spec.files += Dir.glob("doc/**/*.*")
|
9
|
+
# spec.files -= Dir.glob("private/**/*.*")
|
10
|
+
# spec.add_runtime_dependency("rabbit-theme-YOUR-THEME")
|
11
|
+
end
|
12
|
+
|
13
|
+
desc "Tag #{spec.version}"
|
14
|
+
task :tag do
|
15
|
+
sh("git", "tag", "-a", spec.version.to_s, "-m", "Publish #{spec.version}")
|
16
|
+
sh("git", "push", "--tags")
|
17
|
+
end
|
data/config.yaml
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
---
|
2
|
+
id: docs-r-l-o-ja-202406
|
3
|
+
base_name: docs-ruby-lang-org-ja
|
4
|
+
tags:
|
5
|
+
- ruby
|
6
|
+
presentation_date: '2024-06-13'
|
7
|
+
presentation_start_time:
|
8
|
+
presentation_end_time:
|
9
|
+
version: 2024.6.13.0
|
10
|
+
licenses: []
|
11
|
+
slideshare_id: docs-ruby-lang-org-ja-github-actions
|
12
|
+
speaker_deck_id: nosheng-cheng-fang-fa-wobian-eta
|
13
|
+
vimeo_id:
|
14
|
+
youtube_id:
|
15
|
+
width: 800
|
16
|
+
height: 600
|
17
|
+
source_code_uri:
|
18
|
+
author:
|
19
|
+
markup_language: :markdown
|
20
|
+
name: Kazuhiro NISHIYAMA
|
21
|
+
email: zn@mbf.nifty.com
|
22
|
+
rubygems_user: znz
|
23
|
+
slideshare_user: znzjp
|
24
|
+
speaker_deck_user: znz
|
@@ -0,0 +1,141 @@
|
|
1
|
+
# docs.ruby-lang.org/ja/ の生成方法を変えた
|
2
|
+
|
3
|
+
author
|
4
|
+
: Kazuhiro NISHIYAMA
|
5
|
+
|
6
|
+
content-source
|
7
|
+
: 【大阪オフライン開催】RubyKaigi 2024 KaigiEffect発表会
|
8
|
+
|
9
|
+
date
|
10
|
+
: 2024-06-13
|
11
|
+
|
12
|
+
allotted-time
|
13
|
+
: 15m
|
14
|
+
|
15
|
+
theme
|
16
|
+
: lightning-simple
|
17
|
+
|
18
|
+
# self.introduction
|
19
|
+
|
20
|
+
- 西山 和広
|
21
|
+
- Ruby のコミッター
|
22
|
+
- github など: `@znz`
|
23
|
+
- 株式会社Ruby開発 www.ruby-dev.jp
|
24
|
+
|
25
|
+
# 前の方法
|
26
|
+
|
27
|
+
- `docs.ruby-lang.org` で生成
|
28
|
+
- `bc-setup-all` で `bitclust` の `db-*` を生成
|
29
|
+
- `bc-static-all` で static html を生成 (`/ja/バージョン/` の内容)
|
30
|
+
- `update-rurema-index` で `rurema-search` のインデックスを更新 (`/ja/search/` の内容)
|
31
|
+
|
32
|
+
# 問題発生
|
33
|
+
|
34
|
+
- パターンマッチのドキュメントを ruby/ruby の rdoc を翻訳する形で追加 <https://github.com/rurema/doctree/pull/2773>
|
35
|
+
のマージで問題発生
|
36
|
+
- CI はサポートバージョンでしか動いていなかった
|
37
|
+
|
38
|
+
```
|
39
|
+
% curl -s 'https://cache.ruby-lang.org/pub/misc/ci_versions/cruby.json' | jq -c '. + []'
|
40
|
+
["3.1","3.2","3.3","head"]
|
41
|
+
```
|
42
|
+
|
43
|
+
# docs の ruby
|
44
|
+
|
45
|
+
- Debian GNU/Linux 11 (bullseye) の `/usr/bin/ruby` だと
|
46
|
+
`ruby 2.7.4p191 (2021-07-07 revision a21a3b7d23) [x86_64-linux-gnu]`
|
47
|
+
- <https://snapcraft.io/ruby> の最新安定版を使っていたこともあったが
|
48
|
+
`rurema-search` との兼ね合いで `/usr/bin/ruby` に戻していた
|
49
|
+
|
50
|
+
# HTML 生成の Docker 化
|
51
|
+
|
52
|
+
- 生成された db と html を入れても `.git` は 140M ぐらい
|
53
|
+
- [GitHub のリポジトリサイズ制限](https://docs.github.com/ja/repositories/working-with-files/managing-large-files/about-large-files-on-github#repository-size-limits)
|
54
|
+
> リポジトリは小さく保ち、理想としては 1GB 未満、および 5GB 未満にすることを強くお勧めします。
|
55
|
+
- 生成したファイルもリポジトリ管理に
|
56
|
+
|
57
|
+
# rurema-search の Docker 化
|
58
|
+
|
59
|
+
- rurema-search のインデックス作成も Docker 化
|
60
|
+
- インデックスはバイナリで git 管理には向かなさそう
|
61
|
+
- かつ毎回再生成すれば良さそう
|
62
|
+
- リポジトリ管理にはせず
|
63
|
+
|
64
|
+
# 古いドキュメントの保存
|
65
|
+
|
66
|
+
- HTML ファイルは `ja/1.8.7` から残っていた
|
67
|
+
- `https://github.com/rurema/generated-documents` に保存
|
68
|
+
- `db-*` は EC2 を今の docs-2020 に移行したときに残していなかった
|
69
|
+
- `db-2.4.0` 以降のみ現存
|
70
|
+
- rurema-search には `db-*` が必要だったが 2.3 以前はないまま
|
71
|
+
- <https://docs.ruby-lang.org/ja/search/> は現状維持
|
72
|
+
|
73
|
+
# GitHub Actions で生成
|
74
|
+
|
75
|
+
- `github.com/ruby` ではなく `github.com/rurema` に作成
|
76
|
+
- 権限がなくて S3 へ置けない
|
77
|
+
- リポジトリに置くことにした
|
78
|
+
- 更新は [生成して pull request を作成して自動マージする](https://github.com/rurema/generated-documents/blob/902da064105c1949907204d4bb5ca0ea40c83e17/.github/workflows/generate.yml) workflow
|
79
|
+
|
80
|
+
# docs 側の更新方法変更
|
81
|
+
|
82
|
+
- pull してきて反映
|
83
|
+
- `bc-setup-all` で `rurema/generated-documents` をとってきて `db-*` の symlink 作成
|
84
|
+
- `bc-static-all` は static html を `rsync` で反映
|
85
|
+
- `update-rurema-index` は今まで通り
|
86
|
+
|
87
|
+
# 今後の予定
|
88
|
+
|
89
|
+
- `rurema/generated-documents` の生成済ファイルは埋め込まれているタグなどの関係で docs.ruby-lang.org 専用 → うまく分離したい
|
90
|
+
- `docs.ruby-lang.org` の環境軽量化
|
91
|
+
- HTML 生成部分は完了
|
92
|
+
- `rurema-search` は生成されるインデックスだけで 600M 越え (heroku の slug の 500M 制限超過) で静的ファイルのホスティング + Heroku への移行は無理そう
|
93
|
+
- <https://github.com/ruby/docs.ruby-lang.org>
|
94
|
+
にある ansible の playbook も現状と合わないので EC2 インスタンス作り直し?
|
95
|
+
|
96
|
+
# 残作業
|
97
|
+
|
98
|
+
- bitclust への型付けをしつつコードリーディングの続き
|
99
|
+
- kramdown への型付け (まだなければ)
|
100
|
+
- 開発環境の devcontainer 化 (bitclust 開発者向けと doctree 執筆者向け)
|
101
|
+
- bitclust の markdown 対応
|
102
|
+
|
103
|
+
# rurema の markdown 対応
|
104
|
+
|
105
|
+
- bitclust に markdown 対応機能追加
|
106
|
+
- markdown 移行前に doctree の pull request 一掃
|
107
|
+
- doctree で markdown に一部書き換え
|
108
|
+
- doctree の書き換えでわかった bitclust で markdown 対応の問題点修正
|
109
|
+
- rurema-search の markdown 対応
|
110
|
+
|
111
|
+
# rurema の markdown 対応
|
112
|
+
|
113
|
+
- doctree で全面的に markdown 対応
|
114
|
+
- doctree の RDベース記法のドキュメント削除
|
115
|
+
- bitclust から RD 対応を削除
|
116
|
+
|
117
|
+
# その他のやりたいこと
|
118
|
+
|
119
|
+
- irb でのドキュメント表示対応
|
120
|
+
- ドキュメント内部での ruby.wasm での実行対応
|
121
|
+
- ドキュメント執筆補助ツール (bitclust の tools) の再整備
|
122
|
+
|
123
|
+
# docs.ruby-lang.org関連
|
124
|
+
|
125
|
+
- (済) rdoc 生成のコンテナ化
|
126
|
+
- 脆弱性のある古い js の対処(?) (古い jquery などが残っているかどうかなどの確認から)
|
127
|
+
- (済) ja html 生成のコンテナ化
|
128
|
+
- GA の削除? (共通 js ファイルにして docs.ruby-lang.org 以外だと空ファイルとかできると良さそう?)
|
129
|
+
- (済) 更新しない古いバージョンをアーカイブファイルでも保存・配布
|
130
|
+
|
131
|
+
# docs.ruby-lang.org関連
|
132
|
+
|
133
|
+
- (済) 新しいバージョンも rurema-search で必要ならアーカイブでも配布
|
134
|
+
- 古いバージョンの `db-*` の再生成
|
135
|
+
- HTML 配信元を EC2 から S3 バックエンドか何かに移行(?)
|
136
|
+
- (途中まで済) rurema-search のコンテナ化かサーバーレス化か何か
|
137
|
+
|
138
|
+
# 直近
|
139
|
+
|
140
|
+
- (済) rurema-search で master が 3.4 のようにバージョンで出てきてリンク切れになる問題の対策
|
141
|
+
- <https://docs.ruby-lang.org/ja/> と <https://docs.ruby-lang.org/en/> のサポート終了バージョンの更新
|
Binary file
|
metadata
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rabbit-slide-znz-docs-r-l-o-ja-202406
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 2024.6.13.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kazuhiro NISHIYAMA
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2024-06-13 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rabbit
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 2.0.2
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 2.0.2
|
27
|
+
description: "[【大阪オフライン開催】RubyKaigi 2024 KaigiEffect発表会](https://kyobashirb.connpass.com/event/320687/)
|
28
|
+
の発表資料です。"
|
29
|
+
email:
|
30
|
+
- zn@mbf.nifty.com
|
31
|
+
executables: []
|
32
|
+
extensions: []
|
33
|
+
extra_rdoc_files: []
|
34
|
+
files:
|
35
|
+
- ".rabbit"
|
36
|
+
- README.md
|
37
|
+
- README.md~
|
38
|
+
- Rakefile
|
39
|
+
- config.yaml
|
40
|
+
- docs-ruby-lang-org-ja.md
|
41
|
+
- pdf/docs-r-l-o-ja-202406-docs-ruby-lang-org-ja.pdf
|
42
|
+
homepage: https://slide.rabbit-shocker.org/authors/znz/docs-r-l-o-ja-202406/
|
43
|
+
licenses: []
|
44
|
+
metadata: {}
|
45
|
+
post_install_message:
|
46
|
+
rdoc_options: []
|
47
|
+
require_paths:
|
48
|
+
- lib
|
49
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - ">="
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
55
|
+
requirements:
|
56
|
+
- - ">="
|
57
|
+
- !ruby/object:Gem::Version
|
58
|
+
version: '0'
|
59
|
+
requirements: []
|
60
|
+
rubygems_version: 3.5.11
|
61
|
+
signing_key:
|
62
|
+
specification_version: 4
|
63
|
+
summary: docs.ruby-lang.org/ja/ の生成方法を変えた
|
64
|
+
test_files: []
|