Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 133901 - devmanual hosting request
Summary: devmanual hosting request
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Infrastructure
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Gentoo Infrastructure
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-05-20 14:41 UTC by Mark Loeser (RETIRED)
Modified: 2006-05-28 08:59 UTC (History)
3 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Mark Loeser (RETIRED) gentoo-dev 2006-05-20 14:41:43 UTC
plasmaroo and I have been working on redoing the devmanual so that it is easy for us to update and alter, and we have it to the point where we want to get some space on Gentoo infra so it is official.

I talked about this briefly with Ramereth, and hosting it on www.g.o/proj/ is going to be difficult for us since dealing with gorg is not at the top of our list of things to do.  We'd really love to just have a vhost, devmanual.gentoo.org, so that we can dump all of our generated files in there (static html).  It is a lot easier for us that way, and requires no changes to anything else besides giving us both access to read/write to that folder.

I have the svn repository as well, so I can provide a dump for to have that hosted as well.

Thanks,
Comment 1 Lance Albertson (RETIRED) gentoo-dev 2006-05-20 23:11:33 UTC
(In reply to comment #0)

> I talked about this briefly with Ramereth, and hosting it on www.g.o/proj/ is
> going to be difficult for us since dealing with gorg is not at the top of our
> list of things to do.  We'd really love to just have a vhost,
> devmanual.gentoo.org, so that we can dump all of our generated files in there
> (static html).  It is a lot easier for us that way, and requires no changes to
> anything else besides giving us both access to read/write to that folder.

Define what you mean by "dealing with gorg is not at the top of our list of things to do" If you're unwilling to at least trying to get it to work with gorg I'm going to have to object. If there's some technical reason that neysx cannot help you with, then I'm ok with the vhost. I would like to keep this on our main site if its possible.
Comment 2 Tim Yamin (RETIRED) gentoo-dev 2006-05-21 11:25:35 UTC
(In reply to comment #1)
> Define what you mean by "dealing with gorg is not at the top of our list of
> things to do" If you're unwilling to at least trying to get it to work with
> gorg I'm going to have to object. If there's some technical reason that neysx
> cannot help you with, then I'm ok with the vhost. I would like to keep this on
> our main site if its possible.

I've tried with gorg; some issues:

1) The Content-Type header is giving problems -- Gecko is rendering wrongly with application/xml+html (while Opera works fine); forcing gorg to text/html in the code makes things work (the XHTML that's getting spewed out is exactly the same in both cases and is well-formed).
2) It'll look weird on www.gentoo.org given that the layout is totally different plus there's the issue of having to keep .png's along with .svg's in CVS if we're going to go that route; making it not so nice to update given that CVS is fugly with binaries (read: more pain for us).

... so the easiest solution is just serving out static HTML on a vhost where we can dump the files but gorg on www.gentoo.org is doable if you can live with the total lack of www.gentoo.org-ness on the pages.
Comment 3 Mark Loeser (RETIRED) gentoo-dev 2006-05-21 11:40:06 UTC
(In reply to comment #1)
> Define what you mean by "dealing with gorg is not at the top of our list of
> things to do" If you're unwilling to at least trying to get it to work with
> gorg I'm going to have to object. If there's some technical reason that neysx
> cannot help you with, then I'm ok with the vhost. I would like to keep this on
> our main site if its possible.

First thing is that generating our pages is going to be very expensive, with the syntax highlighting, how we handle links, and our table of contents generation.  Alot of it is recursive and goes through the entire tree of our files to make our links, so it is only going to become more and more expensive as we add more content.

Second thing is that since we don't have the same layout, it is going to look kind of crappy being part of www.g.o, imho.  Having it as its own separate vhost makes it look better, to me atleast.

plasmaroo's run some tests and he gets >=1000ms generation on some of the pages.  It seems like using gorg is going to put some extra load on the webnodes, and we are more than happy to process things offsite and serve the static HTML.
Comment 4 Lance Albertson (RETIRED) gentoo-dev 2006-05-21 12:29:18 UTC
Ah ok, thanks for the clarification! I just wanted to make sure we covered all our bases before we went ahead. I have no problem with generating the static files on the server as long as its not extremely intensive. Are you talking about something the runs once an hour?

Anyways, I'm planning on hosting this site on warbler and will probably allow cron jobs to run so you can update/generate your site automatically. I will most likely create a web-like user that either of you sudo to and use. I'll see about getting the vhost setup in the next few days. Ping me in a few days if I haven't replied to the bug by then.
Comment 5 Tim Yamin (RETIRED) gentoo-dev 2006-05-21 12:48:22 UTC
(In reply to comment #4)
> Ah ok, thanks for the clarification! I just wanted to make sure we covered all
> our bases before we went ahead. I have no problem with generating the static
> files on the server as long as its not extremely intensive. Are you talking
> about something the runs once an hour?

That'll float our boat; even us just us uploading them when we update devmanual would work fine.

> Anyways, I'm planning on hosting this site on warbler and will probably allow
> cron jobs to run so you can update/generate your site automatically. I will
> most likely create a web-like user that either of you sudo to and use. I'll see
> about getting the vhost setup in the next few days. Ping me in a few days if I
> haven't replied to the bug by then.

Great, thanks!
Comment 6 Mark Loeser (RETIRED) gentoo-dev 2006-05-21 12:52:20 UTC
(In reply to comment #4)
> Ah ok, thanks for the clarification! I just wanted to make sure we covered all
> our bases before we went ahead. I have no problem with generating the static
> files on the server as long as its not extremely intensive. Are you talking
> about something the runs once an hour?

We can generate them offsite and just copy the stuff over.  No need in regenerating the stuff since >90% of the time there will be no changes, or if you have the few things we need to generate them, we could do it on the box itself.  A cron job isn't necessary either way.


> Anyways, I'm planning on hosting this site on warbler and will probably allow
> cron jobs to run so you can update/generate your site automatically. I will
> most likely create a web-like user that either of you sudo to and use. I'll see
> about getting the vhost setup in the next few days. Ping me in a few days if I
> haven't replied to the bug by then.
> 

Sounds good.  We just need a way to put the generated files there, so a cron job to update it really isn't necessary.  We can do a checkout and regenerate the stuff as necessary.

Thanks
Comment 7 Xavier Neys (RETIRED) gentoo-dev 2006-05-22 03:05:22 UTC
(In reply to comment #2)
> I've tried with gorg; some issues:
> 
> 1) The Content-Type header is giving problems -- Gecko is rendering wrongly
> with application/xml+html (while Opera works fine); forcing gorg to text/html
> in the code makes things work (the XHTML that's getting spewed out is exactly
> the same in both cases and is well-formed).

Well, maybe opera is a better browser then :)
I guess you've hit a bug in gecko.
Serving xhtml as application/xml+html to a user agent that explicitely accepts application/xml+html is very much standards compliant. See http://gentoo.neysx.org/ for a working example.
Does that mean you created anotherXML that you transform with anotherXSL?
I suppose bug #106017 has been a waste of time after all. I should have known better given the requester.

> 2) It'll look weird on www.gentoo.org given that the layout is totally
> different

Indeed

> so the easiest solution is just serving out static HTML on a vhost

you don't really need a vhost to serve static html. Ever read a glep? www.g.o could do that, but...

(In reply to comment #3)
> Second thing is that since we don't have the same layout, it is going to look
> kind of crappy being part of www.g.o, imho.  Having it as its own separate
> vhost makes it look better, to me atleast.

Right, it does look crappy as hell and very much ungentoo. A real shame considering the content and the amount of work that has been put into it.

IMO, it should be kept out of www.g.o because of this ungentooness.
That will not make it look any better though, just more acceptable.
Comment 8 Tim Yamin (RETIRED) gentoo-dev 2006-05-22 05:29:33 UTC
(In reply to comment #7)
> Well, maybe opera is a better browser then :)
> I guess you've hit a bug in gecko.
> Serving xhtml as application/xml+html to a user agent that explicitely accepts
> application/xml+html is very much standards compliant. See
> http://gentoo.neysx.org/ for a working example.

Yeah, definitely looks like a bug in Gecko but if we were to go the gorg route we'd ideally need to work around it so it doesn't look even more crapper; there's a totally weird white border on the bottom of the page even though margins are set to zero in the CSS and a background-color is set; and positioning gets screwed up in a few places. Save the XHTML to a file and open locally and it renders fine... :-/

> Does that mean you created anotherXML that you transform with anotherXSL?

Yep.

> > so the easiest solution is just serving out static HTML on a vhost
> 
> you don't really need a vhost to serve static html. Ever read a glep? www.g.o
> could do that, but...

Yeah, gorg can serve out static HTML great :-] -- the problem is putting the HTML into CVS every time you add/change things (which is a major pain) if it's to go off via www.g.o (and why bother when you have the XML in VCS anyway) so that'll be rather tedious.

> Right, it does look crappy as hell and very much ungentoo. A real shame
> considering the content and the amount of work that has been put into it.
> 
> IMO, it should be kept out of www.g.o because of this ungentooness.
> That will not make it look any better though, just more acceptable.

Agreed.
Comment 9 Xavier Neys (RETIRED) gentoo-dev 2006-05-22 06:57:32 UTC
(In reply to comment #8)
> Yeah, definitely looks like a bug in Gecko but if we were to go the gorg route

Or have an option to prevent application/xml+html from being sent.
Gorg tests whether the user agent accepts it, it would be trivial to add a test against a config option.
It might worth it if that's the only thing that stands against dynamic generation.
Just ask if you're interested.

> > Does that mean you created anotherXML that you transform with anotherXSL?
> Yep.
> ...(and why bother when you have the XML in VCS anyway)

Is this publicly available?

> Yeah, gorg can serve out static HTML great :-]

No, actually, it can't :)
Apache is clever enough to serve it on its own.
Comment 10 Lance Albertson (RETIRED) gentoo-dev 2006-05-22 21:47:31 UTC
Good news! I setup the vhost/accounts/etc on warbler for both of you. If you could try sshing to warbler.g.o and then try sudo /bin/su - gmanual, you should be able to write to the location for your docs. The webserver is pointed at the htdocs dir.

plasmaroo: I noticed you didn't have your ssh key in ldap so you won't be able to login until you add that. You should be able to do that yourself if you look at our ldap howto guide.

Please let me know if you need anything else.
Comment 11 Mark Loeser (RETIRED) gentoo-dev 2006-05-28 08:59:08 UTC
Everything works fine.

Thanks :)