Feature #8636

Documentation hosting on ruby-lang.org

Added by Zachary Scott 9 months ago. Updated 6 months ago.

[ruby-core:56004]
Status:Feedback
Priority:Normal
Assignee:Zachary Scott
Category:doc
Target version:-

Description

We discussed whether RDoc documentation should be hosted on ruby-lang.org.

What domain should we use to host api documentation for Ruby?
ie: (docs|rdoc|ref).ruby-lang.org

IRC Developers Meeting Log:
https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak

I am partial to docs.ruby-lang.org, but open to feedback ofcourse.

History

#1 Updated by Kenta Murata 9 months ago

On Mon, Jul 15, 2013 at 11:38 AM, zzak (Zachary Scott) e@zzak.io wrote:

I am partial to docs.ruby-lang.org, but open to feedback ofcourse.

+1 for docs.ruby-lang.org

--
Kenta Murata
OpenPGP FP = 1D69 ADDE 081C 9CC2 2E54 98C1 CEFE 8AFB 6081 B062

本を書きました!!
『Ruby 逆引きレシピ』 http://www.amazon.co.jp/dp/4798119881/mrkn-22

E-mail: mrkn@mrkn.jp
twitter: http://twitter.com/mrkn/
blog: http://d.hatena.ne.jp/mrkn/

#2 Updated by Martin Dürst 9 months ago

Another +1 for docs.ruby-lang.org. "rdoc" is the tool, not the product.
"ref" would be reference, but around Ruby, the word documentation has
been used much more than reference for what we talk about.

Regards, Martin.

On 2013/07/15 12:04, Kenta Murata wrote:

On Mon, Jul 15, 2013 at 11:38 AM, zzak (Zachary Scott)e@zzak.io wrote:

I am partial to docs.ruby-lang.org, but open to feedback ofcourse.

+1 for docs.ruby-lang.org

#3 Updated by Benoit Daloze 9 months ago

Definitely docs.ruby-lang.org for me between these three.

On 15 July 2013 04:38, zzak (Zachary Scott) e@zzak.io wrote:

Issue #8636 has been reported by zzak (Zachary Scott).


Feature #8636: Documentation hosting on ruby-lang.org
https://bugs.ruby-lang.org/issues/8636

Author: zzak (Zachary Scott)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version:

We discussed whether RDoc documentation should be hosted on ruby-lang.org.

What domain should we use to host api documentation for Ruby?
ie: (docs|rdoc|ref).ruby-lang.org

IRC Developers Meeting Log:
https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak

I am partial to docs.ruby-lang.org, but open to feedback ofcourse.

http://bugs.ruby-lang.org/

#4 Updated by Zachary Scott 6 months ago

  • Status changed from Open to Feedback

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.

https://github.com/zzak/docs.ruby-lang.org

Anyone have some feedback on how the index.html page should look?

#5 Updated by Hiroshi SHIBATA 6 months ago

I'm going to prepare docs.ruby-lang.org.

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.
doc.ruby-lang.org/en is redirection of www.ruby-lang.org/en/documentation. I think this rdoc site is hosting by doc.ruby-lang.org/en.

zzak

How do you think about this url?

#6 Updated by Zachary Scott 6 months ago

Here's my TODO:

  • get README's working as RDoc index page for each version
  • produce a global index page to link to each version

I would prefer docs.ruby-lang.org as it is the best canonical url available for us

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

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?

#7 Updated by Hiroshi SHIBATA 6 months ago

Could you ping okkez and sutou-san?

I send to mail their.

#8 Updated by Kouhei Sutou 6 months ago

zzak (Zachary Scott) wrote:

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

Reference: https://github.com/rdoc/rdoc/pull/254

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?

Does it mean that you put http://docs.ruby-lang.org/ to English documentation? Or http://docs.ruby-lang.org/en/?
http://docs.ruby-lang.org/en/ is OK to me.

Ah, I have one more question.
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.

(I will write a documentation full-text search Web service for RDoc after RDoc supports i18n.)

#9 Updated by Zachary Scott 6 months ago

Hello!

On Oct 7, 2013, at 11:10 AM, "kou (Kouhei Sutou)" kou@cozmixng.org wrote:

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?

Does it mean that you put http://docs.ruby-lang.org/ to English documentation? Or http://docs.ruby-lang.org/en/?
http://docs.ruby-lang.org/en/ is OK to me.

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/

Ah, I have one more question.
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.

If you check rake task I wrote I plan to support stable versions only, ie: docs.ruby-lang.org/en/ruby19_3/

#10 Updated by okkez _ 6 months ago

Sorry for my late response.
I couldn't notice this issue.

zzak (Zachary Scott) wrote:

Hello!

On Oct 7, 2013, at 11:10 AM, "kou (Kouhei Sutou)" kou@cozmixng.org wrote:

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?

Does it mean that you put http://docs.ruby-lang.org/ to English documentation? Or http://docs.ruby-lang.org/en/?
http://docs.ruby-lang.org/en/ is OK to me.

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/

I think docs.ruby-lang.org/ will show links to other languages.
(See doc.ruby-lang.org. It's very very simple page I craeted;-))
Because there is a RUREMA (Japanese version of reference manual).
And we have many tasks to publish i18n docs, so we can describe tasks on docs.ruby-lang.org/.

If you check rake task I wrote I plan to support stable versions only, ie: docs.ruby-lang.org/en/ruby19_3/

I prefer the URI like docs.ruby-lang.org/en/1.9.3/ instead of yours.
Because we can guess URI for available versions.
I think that many light users don't know stable branch name.
We have Japanese version URI such as http://doc.ruby-lang.org/ja/2.0.0/

Which subdomain do you like? doc or docs.
For now, doc.ruby-lang.org is available.

Thanks.

#11 Updated by Zachary Scott 6 months ago

Hello Okkez, Thanks for your feedback!

On Oct 8, 2013, at 10:13 PM, okkez (okkez _) redmine@ruby-lang.org wrote:

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/

I think docs.ruby-lang.org/ will show links to other languages.
(See doc.ruby-lang.org. It's very very simple page I craeted;-))
Because there is a RUREMA (Japanese version of reference manual).
And we have many tasks to publish i18n docs, so we can describe tasks on docs.ruby-lang.org/.

Agree that docs.ruby-lang.org/ should list translations, similar to your page on doc.ruby-lang.org!

If you check rake task I wrote I plan to support stable versions only, ie: docs.ruby-lang.org/en/ruby19_3/

I prefer the URI like docs.ruby-lang.org/en/1.9.3/ instead of yours.
Because we can guess URI for available versions.
I think that many light users don't know stable branch name.
We have Japanese version URI such as http://doc.ruby-lang.org/ja/2.0.0/

For this we need to update my Rakefile to gsub 'ruby19_3' to '1.9.3' to initialize the repository via "git clone", such as:

branch = ruby193
version = branch.gsub('ruby
', '').gsub('_', '.')
git clone --branch=#{branch} git://github.com/ruby/ruby.git version

As of now we are using directory task for #{source_dir} as branch name.

btw, the Rakefile is here: https://github.com/zzak/docs.ruby-lang.org/blob/master/Rakefile

Which subdomain do you like? doc or docs.
For now, doc.ruby-lang.org is available.

I like docs subdomain

Thank you!

#12 Updated by okkez _ 6 months ago

zzak (Zachary Scott) wrote:

I like docs subdomain

This is OK to me.

BTW, we have a repository https://github.com/ruby/doc.ruby-lang.org .
If we decide to use docs subdomain,
we need to rename this to https://github.com/docs.ruby-lang.org and merge zzak/docs.ruby-lang.org .

I think that site structure is as following:

.
├── Rakefile
├── en
│ ├── 1.8.7 (generated by rdoc command)
│ ├── 1.9.3 (generated by rdoc command)
│ ├── 2.0.0 (generated by rdoc command)
│ ├── index.html (version list here)
│ └── trunk (generated by rdoc command)
├── index.html (language list here)
└── ja
├── 1.8.7 (generated by bitclust command)
├── 1.9.3 (generated by bitclust command)
├── 2.0.0 (generated by bitclust command)
├── index.html (version list here)
└── trunk (generated by bitclust command)

#13 Updated by Hiroshi SHIBATA 6 months ago

we need to rename this to https://github.com/docs.ruby-lang.org and merge zzak/docs.ruby-lang.org .

rename done!

#14 Updated by Zachary Scott 6 months ago

Sounds great, thanks okkez!!

On Oct 11, 2013, at 2:00 AM, okkez (okkez _) redmine@ruby-lang.org wrote:

Issue #8636 has been updated by okkez (okkez _).

zzak (Zachary Scott) wrote:

I like docs subdomain

This is OK to me.

BTW, we have a repository https://github.com/ruby/doc.ruby-lang.org .
If we decide to use docs subdomain,
we need to rename this to https://github.com/docs.ruby-lang.org and merge zzak/docs.ruby-lang.org .

I think that site structure is as following:

.
├── Rakefile
├── en
│ ├── 1.8.7 (generated by rdoc command)
│ ├── 1.9.3 (generated by rdoc command)
│ ├── 2.0.0 (generated by rdoc command)
│ ├── index.html (version list here)
│ └── trunk (generated by rdoc command)
├── index.html (language list here)
└── ja
├── 1.8.7 (generated by bitclust command)
├── 1.9.3 (generated by bitclust command)
├── 2.0.0 (generated by bitclust command)
├── index.html (version list here)
└── trunk (generated by bitclust command)


Feature #8636: Documentation hosting on ruby-lang.org
https://bugs.ruby-lang.org/issues/8636#change-42423

Author: zzak (Zachary Scott)
Status: Feedback
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version:

We discussed whether RDoc documentation should be hosted on ruby-lang.org.

What domain should we use to host api documentation for Ruby?
ie: (docs|rdoc|ref).ruby-lang.org

IRC Developers Meeting Log:
https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak

I am partial to docs.ruby-lang.org, but open to feedback ofcourse.

http://bugs.ruby-lang.org/

#15 Updated by Zachary Scott 6 months ago

Thank you shibata-san, could you add me to the new repository?

On Oct 11, 2013, at 2:04 AM, hsbt (Hiroshi SHIBATA) shibata.hiroshi@gmail.com wrote:

Issue #8636 has been updated by hsbt (Hiroshi SHIBATA).

we need to rename this to https://github.com/docs.ruby-lang.org and merge zzak/docs.ruby-lang.org .

rename done!


Feature #8636: Documentation hosting on ruby-lang.org
https://bugs.ruby-lang.org/issues/8636#change-42424

Author: zzak (Zachary Scott)
Status: Feedback
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
Target version:

We discussed whether RDoc documentation should be hosted on ruby-lang.org.

What domain should we use to host api documentation for Ruby?
ie: (docs|rdoc|ref).ruby-lang.org

IRC Developers Meeting Log:
https://bugs.ruby-lang.org/projects/ruby/wiki/DevelopersMeeting20130712#Documentation-hosted-on-ruby-langorg-zzak

I am partial to docs.ruby-lang.org, but open to feedback ofcourse.

http://bugs.ruby-lang.org/

#16 Updated by Hiroshi SHIBATA 6 months ago

zzak

added you into docs.ruby-lang.org administrators.

Also available in: Atom PDF