Whither document hosting?

Doesn't scala-tools offer something for docs?

Thanks,
Razvan

On 2010-11-08, at 5:17 PM, Kenneth McDonald wrote:

> Sigh. After many attempts (aided by many very helpful people) I have concluded that "gh-pages" document hosting is not for me. I've found git too difficult to get working on OS X (yes I did get it working, but wondered why, if someone put a bundle together, they didn't bundle it properly), am puzzled by its need to have to copy files over before committing them (at least, according to the instructions I was given--for which, many thanks), and in general just found git too complex for my needs. Maybe if I had a job that demanded that level of complexity...but for the moment, at least, I don't. Setting up my source on github was remarkably easy. Setting up the docs is remarkably, well, if not difficult, at least tedious. I seem to recall hearing from someone working for github that they'd decided to sep the sources and the documents due to demand. As well as causing all the aforementioned problems, this seems to me to be a remarkably ill-informed solution. I mean, if the API docs aren't part of the source, what the heck are they? Speaking as a tech writer, they should _always_ be in harmony. If you get a situation where your docs are falling behind your source (the most common problem)--hire more tech writers! In a well-structured corporation, your tech docs should _never_ be significantly behind your source. Otherwise your source is just (almost) useless noise to the people who must use it.
>
> Well, enough of that rant. Having decided that gh-pages are not for me, I am at a loss for where to put my docs. I've come across many paid sites, but no "open source" sites. Was wondering if anyone could suggest a site that would allow an upload of a (scaladocs style) site, host it for free, and allow linking through to it. Hoping to get some positives. Looking for a site that allows multiple uploads and looks for the "index.html" file for its primary origin.
>
> Many thanks,
> Ken McDonald

Are you looking for just plain html (plus php) hosting?If so, did you try 000webhost?

On Mon, Nov 8, 2010 at 5:17 PM, Kenneth McDonald <kenneth.m.mcdonald@sbcglobal.net> wrote:

Sigh. After many attempts (aided by many very helpful people) I have concluded that "gh-pages" document hosting is not for me. I've found git too difficult to get working on OS X (yes I did get it working, but wondered why, if someone put a bundle together, they didn't bundle it properly), am puzzled by its need to have to copy files over before committing them (at least, according to the instructions I was given--for which, many thanks), and in general just found git too complex for my needs. Maybe if I had a job that demanded that level of complexity...but for the moment, at least, I don't. Setting up my source on github was remarkably easy. Setting up the docs is remarkably, well, if not difficult, at least tedious. I seem to recall hearing from someone working for github that they'd decided to sep the sources and the documents due to demand. As well as causing all the aforementioned problems, this seems to me to be a remarkably ill-informed solution. I mean, if the API docs aren't part of the source, what the heck are they? Speaking as a tech writer, they should _always_ be in harmony. If you get a situation where your docs are falling behind your source (the most common problem)--hire more tech writers! In a well-structured corporation, your tech docs should _never_ be significantly behind your source. Otherwise your source is just (almost) useless noise to the people who must use it.

Well, enough of that rant. Having decided that gh-pages are not for me, I am at a loss for where to put my docs. I've come across many paid sites, but no "open source" sites. Was wondering if anyone could suggest a site that would allow an upload of a (scaladocs style) site, host it for free, and allow linking through to it. Hoping to get some positives. Looking for a site that allows multiple uploads and looks for the "index.html" file for its primary origin.

Many thanks,
Ken McDonald

000webhost is a quite complete solution, but in its free version it's still :

1 - limited in space (yet it shouldn't be a huge problem if your only material is textual doc files)
2 - a little slower than what the user could hope for.

If these two points doesn't bother you that much, it's a good way to go, though.

Alex

2010/11/9 Naftoli Gugenheim <naftoligug@gmail.com>

Are you looking for just plain html (plus php) hosting?If so, did you try 000webhost?

On Mon, Nov 8, 2010 at 5:17 PM, Kenneth McDonald <kenneth.m.mcdonald@sbcglobal.net> wrote:

Sigh. After many attempts (aided by many very helpful people) I have concluded that "gh-pages" document hosting is not for me. I've found git too difficult to get working on OS X (yes I did get it working, but wondered why, if someone put a bundle together, they didn't bundle it properly), am puzzled by its need to have to copy files over before committing them (at least, according to the instructions I was given--for which, many thanks), and in general just found git too complex for my needs. Maybe if I had a job that demanded that level of complexity...but for the moment, at least, I don't. Setting up my source on github was remarkably easy. Setting up the docs is remarkably, well, if not difficult, at least tedious. I seem to recall hearing from someone working for github that they'd decided to sep the sources and the documents due to demand. As well as causing all the aforementioned problems, this seems to me to be a remarkably ill-informed solution. I mean, if the API docs aren't part of the source, what the heck are they? Speaking as a tech writer, they should _always_ be in harmony. If you get a situation where your docs are falling behind your source (the most common problem)--hire more tech writers! In a well-structured corporation, your tech docs should _never_ be significantly behind your source. Otherwise your source is just (almost) useless noise to the people who must use it.

Well, enough of that rant. Having decided that gh-pages are not for me, I am at a loss for where to put my docs. I've come across many paid sites, but no "open source" sites. Was wondering if anyone could suggest a site that would allow an upload of a (scaladocs style) site, host it for free, and allow linking through to it. Hoping to get some positives. Looking for a site that allows multiple uploads and looks for the "index.html" file for its primary origin.

Many thanks,
Ken McDonald

I don't think 1.5Gb is a problem for the kind of thing Kenneth wants. :)And in terms of speed, I hosted a PHP project with them (over a year ago) and found it to be extremely fast.

On Mon, Nov 8, 2010 at 6:47 PM, Repain Alex <alex.repain@gmail.com> wrote:

000webhost is a quite complete solution, but in its free version it's still :

1 - limited in space (yet it shouldn't be a huge problem if your only material is textual doc files)
2 - a little slower than what the user could hope for.

If these two points doesn't bother you that much, it's a good way to go, though.

Alex

2010/11/9 Naftoli Gugenheim <naftoligug@gmail.com>

Are you looking for just plain html (plus php) hosting?If so, did you try 000webhost?

On Mon, Nov 8, 2010 at 5:17 PM, Kenneth McDonald <kenneth.m.mcdonald@sbcglobal.net> wrote:

Sigh. After many attempts (aided by many very helpful people) I have concluded that "gh-pages" document hosting is not for me. I've found git too difficult to get working on OS X (yes I did get it working, but wondered why, if someone put a bundle together, they didn't bundle it properly), am puzzled by its need to have to copy files over before committing them (at least, according to the instructions I was given--for which, many thanks), and in general just found git too complex for my needs. Maybe if I had a job that demanded that level of complexity...but for the moment, at least, I don't. Setting up my source on github was remarkably easy. Setting up the docs is remarkably, well, if not difficult, at least tedious. I seem to recall hearing from someone working for github that they'd decided to sep the sources and the documents due to demand. As well as causing all the aforementioned problems, this seems to me to be a remarkably ill-informed solution. I mean, if the API docs aren't part of the source, what the heck are they? Speaking as a tech writer, they should _always_ be in harmony. If you get a situation where your docs are falling behind your source (the most common problem)--hire more tech writers! In a well-structured corporation, your tech docs should _never_ be significantly behind your source. Otherwise your source is just (almost) useless noise to the people who must use it.

Well, enough of that rant. Having decided that gh-pages are not for me, I am at a loss for where to put my docs. I've come across many paid sites, but no "open source" sites. Was wondering if anyone could suggest a site that would allow an upload of a (scaladocs style) site, host it for free, and allow linking through to it. Hoping to get some positives. Looking for a site that allows multiple uploads and looks for the "index.html" file for its primary origin.

Many thanks,
Ken McDonald

2010/11/9 Naftoli Gugenheim <naftoligug@gmail.com>

I don't think 1.5Gb is a problem for the kind of thing Kenneth wants. :)And in terms of speed, I hosted a PHP project with them (over a year ago) and found it to be extremely fast.

Hum, my last hosting there is like 2 years old, they may have improved a lot since back then. Listen to Naftoli instead :).

Alex

On Mon, Nov 8, 2010 at 6:47 PM, Repain Alex <alex.repain@gmail.com> wrote:

000webhost is a quite complete solution, but in its free version it's still :

1 - limited in space (yet it shouldn't be a huge problem if your only material is textual doc files)
2 - a little slower than what the user could hope for.

If these two points doesn't bother you that much, it's a good way to go, though.

Alex

2010/11/9 Naftoli Gugenheim <naftoligug@gmail.com>

Are you looking for just plain html (plus php) hosting?If so, did you try 000webhost?

On Mon, Nov 8, 2010 at 5:17 PM, Kenneth McDonald <kenneth.m.mcdonald@sbcglobal.net> wrote:

Sigh. After many attempts (aided by many very helpful people) I have concluded that "gh-pages" document hosting is not for me. I've found git too difficult to get working on OS X (yes I did get it working, but wondered why, if someone put a bundle together, they didn't bundle it properly), am puzzled by its need to have to copy files over before committing them (at least, according to the instructions I was given--for which, many thanks), and in general just found git too complex for my needs. Maybe if I had a job that demanded that level of complexity...but for the moment, at least, I don't. Setting up my source on github was remarkably easy. Setting up the docs is remarkably, well, if not difficult, at least tedious. I seem to recall hearing from someone working for github that they'd decided to sep the sources and the documents due to demand. As well as causing all the aforementioned problems, this seems to me to be a remarkably ill-informed solution. I mean, if the API docs aren't part of the source, what the heck are they? Speaking as a tech writer, they should _always_ be in harmony. If you get a situation where your docs are falling behind your source (the most common problem)--hire more tech writers! In a well-structured corporation, your tech docs should _never_ be significantly behind your source. Otherwise your source is just (almost) useless noise to the people who must use it.

Well, enough of that rant. Having decided that gh-pages are not for me, I am at a loss for where to put my docs. I've come across many paid sites, but no "open source" sites. Was wondering if anyone could suggest a site that would allow an upload of a (scaladocs style) site, host it for free, and allow linking through to it. Hoping to get some positives. Looking for a site that allows multiple uploads and looks for the "index.html" file for its primary origin.

Many thanks,
Ken McDonald

You got answers already in a previous thread, you should indicate what you have tried and
rejected, to avoid duplicate answers.

Kenneth,

May be, you can be interesting by a solution I work on (in alpha
stage) : vscaladoc2.
You have to :
1. generate the doc with vscaladoc2_genjson (doc is generated in json
format under $HOME/.config/vscaladoc2/apis
For maven project, you could try :
mvn org.scala-tools:maven-scala-plugin:2.15.0-SNAPSHOT:genjson
2. upload $HOME/.config/vscaladoc2/apis/${artifactId}/${version}-apidoc.jar.gz
somewhere on an http server (ex in the download section of your github
project)
3. contact me with the url of the archive.

When done you could see results on http://vscaladoc2.alchim31.net/
(who convert .json into html)

The website could also link api in other format (javadoc2, scaladoc, scaladoc2).

/davidB