https://redmine.ruby-lang.org/https://redmine.ruby-lang.org/favicon.ico?17113305112013-07-15T12:23:18ZRuby Issue Tracking SystemRuby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=404982013-07-15T12:23:18Zmrkn (Kenta Murata)muraken@gmail.com
<ul></ul><p>On Mon, Jul 15, 2013 at 11:38 AM, zzak (Zachary Scott) <a href="mailto:e@zzak.io" class="email">e@zzak.io</a> wrote:</p>
<blockquote>
<p>I am partial to docs.ruby-lang.org, but open to feedback ofcourse.</p>
</blockquote>
<p>+1 for docs.ruby-lang.org</p>
<p>--<br>
Kenta Murata<br>
OpenPGP FP = 1D69 ADDE 081C 9CC2 2E54 98C1 CEFE 8AFB 6081 B062</p>
<p>本を書きました!!<br>
『Ruby 逆引きレシピ』 <a href="http://www.amazon.co.jp/dp/4798119881/mrkn-22" class="external">http://www.amazon.co.jp/dp/4798119881/mrkn-22</a></p>
<p>E-mail: <a href="mailto:mrkn@mrkn.jp" class="email">mrkn@mrkn.jp</a><br>
twitter: <a href="http://twitter.com/mrkn/" class="external">http://twitter.com/mrkn/</a><br>
blog: <a href="http://d.hatena.ne.jp/mrkn/" class="external">http://d.hatena.ne.jp/mrkn/</a></p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=404992013-07-15T12:53:17Zduerst (Martin Dürst)duerst@it.aoyama.ac.jp
<ul></ul><p>Another +1 for docs.ruby-lang.org. "rdoc" is the tool, not the product.<br>
"ref" would be reference, but around Ruby, the word documentation has<br>
been used much more than reference for what we talk about.</p>
<p>Regards, Martin.</p>
<p>On 2013/07/15 12:04, Kenta Murata wrote:</p>
<blockquote>
<p>On Mon, Jul 15, 2013 at 11:38 AM, zzak (Zachary Scott)<a href="mailto:e@zzak.io" class="email">e@zzak.io</a> wrote:</p>
<blockquote>
<p>I am partial to docs.ruby-lang.org, but open to feedback ofcourse.</p>
</blockquote>
<p>+1 for docs.ruby-lang.org</p>
</blockquote> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=405052013-07-15T21:23:10ZEregon (Benoit Daloze)
<ul></ul><p>Definitely docs.ruby-lang.org for me between these three.</p>
<p>On 15 July 2013 04:38, zzak (Zachary Scott) <a href="mailto:e@zzak.io" class="email">e@zzak.io</a> wrote:</p>
<blockquote>
<p>Issue <a class="issue tracker-2 status-5 priority-4 priority-default closed" title="Feature: Documentation hosting on ruby-lang.org (Closed)" href="https://redmine.ruby-lang.org/issues/8636">#8636</a> has been reported by zzak (Zachary Scott).</p>
<hr>
<p>Feature <a class="issue tracker-2 status-5 priority-4 priority-default closed" title="Feature: Documentation hosting on ruby-lang.org (Closed)" href="https://redmine.ruby-lang.org/issues/8636">#8636</a>: Documentation hosting on ruby-lang.org<br>
<a href="https://bugs.ruby-lang.org/issues/8636" class="external">https://bugs.ruby-lang.org/issues/8636</a></p>
<p>Author: zzak (Zachary Scott)<br>
Status: Open<br>
Priority: Normal<br>
Assignee: zzak (Zachary Scott)<br>
Category: doc<br>
Target version:</p>
<p>We discussed whether RDoc documentation should be hosted on ruby-lang.org.</p>
<p>What domain should we use to host api documentation for Ruby?<br>
ie: (docs|rdoc|ref).ruby-lang.org</p>
<p>IRC Developers Meeting Log:<br>
<a href="https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak" class="external">https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak</a></p>
<p>I am partial to docs.ruby-lang.org, but open to feedback ofcourse.</p>
<p>--<br>
<a href="http://bugs.ruby-lang.org/" class="external">http://bugs.ruby-lang.org/</a></p>
</blockquote> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=423022013-10-06T08:45:29Zzzak (zzak _)
<ul><li><strong>Status</strong> changed from <i>Open</i> to <i>Feedback</i></li></ul><p>I have a build script setup on github. It needs an index page and to be tested before we can get the server and dns going.</p>
<p><a href="https://github.com/zzak/docs.ruby-lang.org" class="external">https://github.com/zzak/docs.ruby-lang.org</a></p>
<p>Anyone have some feedback on how the index.html page should look?</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=423042013-10-06T09:13:36Zhsbt (Hiroshi SHIBATA)hsbt@ruby-lang.org
<ul></ul><p>I'm going to prepare docs.ruby-lang.org.</p>
<p>but I worried about doc.ruby-lang.org and docs.ruby-lang.org. doc is Japanese only and docs is English only. this situation is very confusion.<br>
doc.ruby-lang.org/en is redirection of <a href="http://www.ruby-lang.org/en/documentation" class="external">www.ruby-lang.org/en/documentation</a>. I think this rdoc site is hosting by doc.ruby-lang.org/en.</p>
<blockquote>
<p>zzak</p>
</blockquote>
<p>How do you think about this url?</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=423062013-10-06T20:08:42Zzzak (zzak _)
<ul></ul><p>Here's my TODO:</p>
<ul>
<li>get README's working as RDoc index page for each version</li>
<li>produce a global index page to link to each version</li>
</ul>
<p>I would prefer docs.ruby-lang.org as it is the best canonical url available for us</p>
<p>We are also working on i18n support for RDoc so the japanese documentation team will not have to maintain a separate repository. Eventually with this supported, we can move to docs.ruby-lang.org/LANG</p>
<p>For now, I think we should just have docs.ruby-lang.org be the english documentation site. However, I'd like more feedback from the RUREMA team. Could you ping okkez and sutou-san?</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=423072013-10-07T06:34:50Zhsbt (Hiroshi SHIBATA)hsbt@ruby-lang.org
<ul></ul><blockquote>
<p>Could you ping okkez and sutou-san?</p>
</blockquote>
<p>I send to mail their.</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=423142013-10-08T00:10:24Zkou (Kouhei Sutou)kou@cozmixng.org
<ul></ul><p>zzak (Zachary Scott) wrote:</p>
<blockquote>
<p>We are also working on i18n support for RDoc so the japanese documentation team will not have to maintain a separate repository. Eventually with this supported, we can move to docs.ruby-lang.org/LANG</p>
</blockquote>
<p>Reference: <a href="https://github.com/rdoc/rdoc/pull/254" class="external">https://github.com/rdoc/rdoc/pull/254</a></p>
<blockquote>
<p>For now, I think we should just have docs.ruby-lang.org be the english documentation site. However, I'd like more feedback from the RUREMA team. Could you ping okkez and sutou-san?</p>
</blockquote>
<p>Does it mean that you put <a href="http://docs.ruby-lang.org/" class="external">http://docs.ruby-lang.org/</a> to English documentation? Or <a href="http://docs.ruby-lang.org/en/" class="external">http://docs.ruby-lang.org/en/</a>?<br>
<a href="http://docs.ruby-lang.org/en/" class="external">http://docs.ruby-lang.org/en/</a> is OK to me.</p>
<p>Ah, I have one more question.<br>
How do you think about multi-version hosting? doc.ruby-lang.org/ hosts only the latest stable version? Or it hosts all available versions? I think that it is better the latter because there are many old stable (1.9.x) users.</p>
<p>(I will write a documentation full-text search Web service for RDoc after RDoc supports i18n.)</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=423392013-10-09T01:23:20Zzzak (zzak _)
<ul></ul><p>Hello!</p>
<blockquote>
<p>On Oct 7, 2013, at 11:10 AM, "kou (Kouhei Sutou)" <a href="mailto:kou@cozmixng.org" class="email">kou@cozmixng.org</a> wrote:</p>
<blockquote>
<p>For now, I think we should just have docs.ruby-lang.org be the english documentation site. However, I'd like more feedback from the RUREMA team. Could you ping okkez and sutou-san?</p>
</blockquote>
<p>Does it mean that you put <a href="http://docs.ruby-lang.org/" class="external">http://docs.ruby-lang.org/</a> to English documentation? Or <a href="http://docs.ruby-lang.org/en/" class="external">http://docs.ruby-lang.org/en/</a>?<br>
<a href="http://docs.ruby-lang.org/en/" class="external">http://docs.ruby-lang.org/en/</a> is OK to me.</p>
</blockquote>
<p>I think docs.ruby-lang.org/en will be default for now, as we add more translations we can list them on: docs.ruby-lang.org/</p>
<blockquote>
<p>Ah, I have one more question.<br>
How do you think about multi-version hosting? doc.ruby-lang.org/ hosts only the latest stable version? Or it hosts all available versions? I think that it is better the latter because there are many old stable (1.9.x) users.</p>
</blockquote>
<p>If you check rake task I wrote I plan to support stable versions only, ie: docs.ruby-lang.org/en/ruby_1_9_3/</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=423552013-10-09T11:13:50Zokkez (okkez _)
<ul></ul><p>Sorry for my late response.<br>
I couldn't notice this issue.</p>
<p>zzak (Zachary Scott) wrote:</p>
<blockquote>
<p>Hello!</p>
<blockquote>
<p>On Oct 7, 2013, at 11:10 AM, "kou (Kouhei Sutou)" <a href="mailto:kou@cozmixng.org" class="email">kou@cozmixng.org</a> wrote:</p>
<blockquote>
<p>For now, I think we should just have docs.ruby-lang.org be the english documentation site. However, I'd like more feedback from the RUREMA team. Could you ping okkez and sutou-san?</p>
</blockquote>
<p>Does it mean that you put <a href="http://docs.ruby-lang.org/" class="external">http://docs.ruby-lang.org/</a> to English documentation? Or <a href="http://docs.ruby-lang.org/en/" class="external">http://docs.ruby-lang.org/en/</a>?<br>
<a href="http://docs.ruby-lang.org/en/" class="external">http://docs.ruby-lang.org/en/</a> is OK to me.</p>
</blockquote>
<p>I think docs.ruby-lang.org/en will be default for now, as we add more translations we can list them on: docs.ruby-lang.org/</p>
</blockquote>
<p>I think docs.ruby-lang.org/ will show links to other languages.<br>
(See doc.ruby-lang.org. It's very very simple page I craeted;-))<br>
Because there is a RUREMA (Japanese version of reference manual).<br>
And we have many tasks to publish i18n docs, so we can describe tasks on docs.ruby-lang.org/.</p>
<blockquote>
<p>If you check rake task I wrote I plan to support stable versions only, ie: docs.ruby-lang.org/en/ruby_1_9_3/</p>
</blockquote>
<p>I prefer the URI like docs.ruby-lang.org/en/1.9.3/ instead of yours.<br>
Because we can guess URI for available versions.<br>
I think that many light users don't know stable branch name.<br>
We have Japanese version URI such as <a href="http://doc.ruby-lang.org/ja/2.0.0/" class="external">http://doc.ruby-lang.org/ja/2.0.0/</a></p>
<p>Which subdomain do you like? doc or docs.<br>
For now, doc.ruby-lang.org is available.</p>
<p>Thanks.</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=423712013-10-09T21:53:21Zzzak (zzak _)
<ul></ul><p>Hello Okkez, Thanks for your feedback!</p>
<p>On Oct 8, 2013, at 10:13 PM, okkez (okkez _) <a href="mailto:redmine@ruby-lang.org" class="email">redmine@ruby-lang.org</a> wrote:</p>
<blockquote>
<blockquote>
<p>I think docs.ruby-lang.org/en will be default for now, as we add more translations we can list them on: docs.ruby-lang.org/</p>
</blockquote>
<p>I think docs.ruby-lang.org/ will show links to other languages.<br>
(See doc.ruby-lang.org. It's very very simple page I craeted;-))<br>
Because there is a RUREMA (Japanese version of reference manual).<br>
And we have many tasks to publish i18n docs, so we can describe tasks on docs.ruby-lang.org/.</p>
</blockquote>
<p>Agree that docs.ruby-lang.org/ should list translations, similar to your page on doc.ruby-lang.org!</p>
<blockquote>
<blockquote>
<p>If you check rake task I wrote I plan to support stable versions only, ie: docs.ruby-lang.org/en/ruby_1_9_3/</p>
</blockquote>
<p>I prefer the URI like docs.ruby-lang.org/en/1.9.3/ instead of yours.<br>
Because we can guess URI for available versions.<br>
I think that many light users don't know stable branch name.<br>
We have Japanese version URI such as <a href="http://doc.ruby-lang.org/ja/2.0.0/" class="external">http://doc.ruby-lang.org/ja/2.0.0/</a></p>
</blockquote>
<p>For this we need to update my Rakefile to gsub 'ruby_1_9_3' to '1.9.3' to initialize the repository via "git clone", such as:</p>
<p>branch = ruby_1_9_3<br>
version = branch.gsub('ruby_', '').gsub('_', '.')<br>
<code>git clone --branch=#{branch} git://github.com/ruby/ruby.git version</code></p>
<p>As of now we are using directory task for #{source_dir} as branch name.</p>
<p>btw, the Rakefile is here: <a href="https://github.com/zzak/docs.ruby-lang.org/blob/master/Rakefile" class="external">https://github.com/zzak/docs.ruby-lang.org/blob/master/Rakefile</a></p>
<blockquote>
<p>Which subdomain do you like? doc or docs.<br>
For now, doc.ruby-lang.org is available.</p>
</blockquote>
<p>I like docs subdomain</p>
<p>Thank you!</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=424232013-10-11T15:00:06Zokkez (okkez _)
<ul></ul><p>zzak (Zachary Scott) wrote:</p>
<blockquote>
<p>I like docs subdomain</p>
</blockquote>
<p>This is OK to me.</p>
<p>BTW, we have a repository <a href="https://github.com/ruby/doc.ruby-lang.org" class="external">https://github.com/ruby/doc.ruby-lang.org</a> .<br>
If we decide to use docs subdomain,<br>
we need to rename this to <a href="https://github.com/docs.ruby-lang.org" class="external">https://github.com/docs.ruby-lang.org</a> and merge zzak/docs.ruby-lang.org .</p>
<p>I think that site structure is as following:</p>
<p>.<br>
├── Rakefile<br>
├── en<br>
│ ├── 1.8.7 (generated by rdoc command)<br>
│ ├── 1.9.3 (generated by rdoc command)<br>
│ ├── 2.0.0 (generated by rdoc command)<br>
│ ├── index.html (version list here)<br>
│ └── trunk (generated by rdoc command)<br>
├── index.html (language list here)<br>
└── ja<br>
├── 1.8.7 (generated by bitclust command)<br>
├── 1.9.3 (generated by bitclust command)<br>
├── 2.0.0 (generated by bitclust command)<br>
├── index.html (version list here)<br>
└── trunk (generated by bitclust command)</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=424242013-10-11T15:04:44Zhsbt (Hiroshi SHIBATA)hsbt@ruby-lang.org
<ul></ul><blockquote>
<p>we need to rename this to <a href="https://github.com/docs.ruby-lang.org" class="external">https://github.com/docs.ruby-lang.org</a> and merge zzak/docs.ruby-lang.org .</p>
</blockquote>
<p>rename done!</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=424262013-10-11T21:23:12Zzzak (zzak _)
<ul></ul><p>Sounds great, thanks okkez!!</p>
<p>On Oct 11, 2013, at 2:00 AM, okkez (okkez _) <a href="mailto:redmine@ruby-lang.org" class="email">redmine@ruby-lang.org</a> wrote:</p>
<blockquote>
<p>Issue <a class="issue tracker-2 status-5 priority-4 priority-default closed" title="Feature: Documentation hosting on ruby-lang.org (Closed)" href="https://redmine.ruby-lang.org/issues/8636">#8636</a> has been updated by okkez (okkez _).</p>
<p>zzak (Zachary Scott) wrote:</p>
<blockquote>
<p>I like docs subdomain</p>
</blockquote>
<p>This is OK to me.</p>
<p>BTW, we have a repository <a href="https://github.com/ruby/doc.ruby-lang.org" class="external">https://github.com/ruby/doc.ruby-lang.org</a> .<br>
If we decide to use docs subdomain,<br>
we need to rename this to <a href="https://github.com/docs.ruby-lang.org" class="external">https://github.com/docs.ruby-lang.org</a> and merge zzak/docs.ruby-lang.org .</p>
<p>I think that site structure is as following:</p>
<p>.<br>
├── Rakefile<br>
├── en<br>
│ ├── 1.8.7 (generated by rdoc command)<br>
│ ├── 1.9.3 (generated by rdoc command)<br>
│ ├── 2.0.0 (generated by rdoc command)<br>
│ ├── index.html (version list here)<br>
│ └── trunk (generated by rdoc command)<br>
├── index.html (language list here)<br>
└── ja<br>
├── 1.8.7 (generated by bitclust command)<br>
├── 1.9.3 (generated by bitclust command)<br>
├── 2.0.0 (generated by bitclust command)<br>
├── index.html (version list here)<br>
└── trunk (generated by bitclust command)</p>
<hr>
<p>Feature <a class="issue tracker-2 status-5 priority-4 priority-default closed" title="Feature: Documentation hosting on ruby-lang.org (Closed)" href="https://redmine.ruby-lang.org/issues/8636">#8636</a>: Documentation hosting on ruby-lang.org<br>
<a href="https://bugs.ruby-lang.org/issues/8636#change-42423" class="external">https://bugs.ruby-lang.org/issues/8636#change-42423</a></p>
<p>Author: zzak (Zachary Scott)<br>
Status: Feedback<br>
Priority: Normal<br>
Assignee: zzak (Zachary Scott)<br>
Category: doc<br>
Target version:</p>
<p>We discussed whether RDoc documentation should be hosted on ruby-lang.org.</p>
<p>What domain should we use to host api documentation for Ruby?<br>
ie: (docs|rdoc|ref).ruby-lang.org</p>
<p>IRC Developers Meeting Log:<br>
<a href="https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak" class="external">https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak</a></p>
<p>I am partial to docs.ruby-lang.org, but open to feedback ofcourse.</p>
<p>--<br>
<a href="http://bugs.ruby-lang.org/" class="external">http://bugs.ruby-lang.org/</a></p>
</blockquote> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=424272013-10-11T21:23:12Zzzak (zzak _)
<ul></ul><p>Thank you shibata-san, could you add me to the new repository?</p>
<p>On Oct 11, 2013, at 2:04 AM, hsbt (Hiroshi SHIBATA) <a href="mailto:shibata.hiroshi@gmail.com" class="email">shibata.hiroshi@gmail.com</a> wrote:</p>
<blockquote>
<p>Issue <a class="issue tracker-2 status-5 priority-4 priority-default closed" title="Feature: Documentation hosting on ruby-lang.org (Closed)" href="https://redmine.ruby-lang.org/issues/8636">#8636</a> has been updated by hsbt (Hiroshi SHIBATA).</p>
<blockquote>
<p>we need to rename this to <a href="https://github.com/docs.ruby-lang.org" class="external">https://github.com/docs.ruby-lang.org</a> and merge zzak/docs.ruby-lang.org .</p>
</blockquote>
<p>rename done!</p>
<hr>
<p>Feature <a class="issue tracker-2 status-5 priority-4 priority-default closed" title="Feature: Documentation hosting on ruby-lang.org (Closed)" href="https://redmine.ruby-lang.org/issues/8636">#8636</a>: Documentation hosting on ruby-lang.org<br>
<a href="https://bugs.ruby-lang.org/issues/8636#change-42424" class="external">https://bugs.ruby-lang.org/issues/8636#change-42424</a></p>
<p>Author: zzak (Zachary Scott)<br>
Status: Feedback<br>
Priority: Normal<br>
Assignee: zzak (Zachary Scott)<br>
Category: doc<br>
Target version:</p>
<p>We discussed whether RDoc documentation should be hosted on ruby-lang.org.</p>
<p>What domain should we use to host api documentation for Ruby?<br>
ie: (docs|rdoc|ref).ruby-lang.org</p>
<p>IRC Developers Meeting Log:<br>
<a href="https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak" class="external">https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak</a></p>
<p>I am partial to docs.ruby-lang.org, but open to feedback ofcourse.</p>
<p>--<br>
<a href="http://bugs.ruby-lang.org/" class="external">http://bugs.ruby-lang.org/</a></p>
</blockquote> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=424282013-10-11T21:57:58Zhsbt (Hiroshi SHIBATA)hsbt@ruby-lang.org
<ul></ul><blockquote>
<p>zzak</p>
</blockquote>
<p>added you into docs.ruby-lang.org administrators.</p> Ruby master - Feature #8636: Documentation hosting on ruby-lang.orghttps://redmine.ruby-lang.org/issues/8636?journal_id=480922014-07-27T21:04:20Zzzak (zzak _)
<ul><li><strong>Status</strong> changed from <i>Feedback</i> to <i>Closed</i></li></ul><p>I'm marking this as closed as we are working on it outside of redmine, and has no effect on trunk or other ruby version development.</p>
<p>Stay tuned!</p>