[Omake] doc/html reorg.

Jason Hickey jyh at cs.caltech.edu
Thu Oct 25 15:07:15 PDT 2007


Aleksey,

This sounds good to me, just I'm a little confused about what is what.

How about something like:
    doc/src/{tex,html,images,...}: the stuff we edit, including local  
generated files
    doc/release/0.9.8.x/...: copy from src to here when a release  
happens
or something similar that clearly identifies which files are hand- 
written.

My main worry is that I will get confused about how to find the files  
I should be editing, so I'd like it to be idiot-proof.

Jason

On Oct 25, 2007, at 2:26 PM, Aleksey Nogin wrote:

> Jason,
>
> I have reorganized the doc/html and wanted to run this by you  
> before I commit:
>
> doc/webpage - manually edited web files (moved from doc/html)
> doc/webpage/images - gifs for the web page (copied from doc/html/ 
> images)
> doc/webpage/manual - auto-generated files _snapshot_ (copied from  
> doc/html)
> doc/html - latest auto-generated files (all manual files deleted)
> doc/images - all image stuff - .gif, .ai, .eps, etc (renamed from  
> doc/html/images)
>
> The idea is to point the web page at doc/webpage, where the doc/ 
> webpage/manual would only ever contain "release-worthy" snapshots  
> of the auto-generated files (even if it is on some obscure branch).  
> The doc/html would now be a separate repository for the latest  
> generated doc files, never directly exposed to the main web page).  
> Posting the latest documentation on the web would now require one  
> extra step (copying from doc/html to doc/webpage/manual and from  
> doc/images/*{gif,jpg,png} to doc/webpage/images) - essentially  
> "blessing" a particular auto-generated version, so I think it's a  
> good thing to have it.
>
> Later we can rename the manual directory to something like  
> manual-0.9.8.6 and create a setup for keeping several versions side- 
> to-side...
>
> Aleksey
>
> -- 
> Aleksey Nogin, Research Scientist
> Advanced Technologies Department, Information & System Sciences Lab
> HRL Laboratories, LLC, Malibu, CA
> _______________________________________________
> OMake-Devel mailing list
> OMake-Devel at metaprl.org
> https://lists.metaprl.org/mailman/listinfo/omake-devel

--
Jason Hickey                  http://www.cs.caltech.edu/~jyh
Caltech Computer Science      Tel: 626-395-6568 FAX: 626-792-4257





More information about the OMake-Devel mailing list