[m-rev.] for review: install release documentation on web page

[Peter Ross]

On Mon, Oct 08, 2001 at 03:40:04PM +1000, Simon Taylor wrote:
> 
> Pete, could you please review this. There's an installed version in
> /home/earth/stayl/opt/mercury/installed_w3.
> 
> Simon.
> 
> 
> Estimated hours taken: 4
> 
> Put the documentation for the current release on the web page,
> as well as the documentation for the latest snapshot.
> 
> w3/RELEASE_INFO:
> 	Contains `make' variables describing the name and CVS tag of
> 	the current official release.
> 
> compiler/notes/release_checklist.html:
> 	w3/RELEASE_INFO needs to be updated for each release.
> 
> w3/include/globals.inc.in:
> 	Add a variable containing the name of the current official release.
> 
> w3/include/globals.inc:
> 	Removed.
> 
> w3/Makefile:
> 	Build globals.inc by filling in the name of the current release
> 	in globals.inc.in with the name from RELEASE_INFO.
> 
> w3/Makefile.common:
> 	All HTML files depend on globals.inc.	
> 
> w3/information/Makefile:
> 	Check out and build the documentation for both the
> 	release branch and the main branch.
> 
> w3/include/menubar.inc:
> w3/information/include/documentation.inc:
> 	Add the release versions of the documentation to the
> 	`Documentation' page and menubar.
> 
> w3/information/developers/remote_cvs.html:
> w3/information/include/developer.inc:
> w3/news/newsdb.inc:
> w3/tutorial/defs.m4:
> 	Update the location of the documentation on the web page
> 	(`doc-release' or `doc-latest' rather than just `doc').
> 
> 
> Index: w3/Makefile
> ===================================================================
> RCS file: /home/mercury1/repository/w3/Makefile,v
> retrieving revision 1.14
> diff -u -u -r1.14 Makefile
> --- w3/Makefile	28 Mar 2001 12:28:50 -0000	1.14
> +++ w3/Makefile	6 Oct 2001 04:09:20 -0000
> @@ -4,6 +4,8 @@
>  # Public License - see the file COPYING in the Mercury distribution.
>  #-----------------------------------------------------------------------------#
>  
> +include RELEASE_INFO
> +
>  HTML=	index.html 		\
>  	mcorba.html		\
>  	news.html 		\
> @@ -23,6 +25,13 @@
>  
>  target: html
>  
> +html: globals.inc
> +
> +globals.inc: include/globals.inc
> +

Shouldn't that just be

html: include/globals.inc


> +include/globals.inc: include/globals.inc.in
> +	sed -e "s/<RELEASE_VERSION>/$(RELEASE_VERSION)/" < $< > $@
> +
>  index.html: latest_news.inc newsdb.inc
>  news.html: latest_news.inc newsdb.inc
>  mcorba.html: mcorba_newsdb.inc
> @@ -34,6 +43,10 @@
>  	chgrp -R mercury $(INSTALL_WEBDIR)/images
>  	chmod -R g+w,a+r $(INSTALL_WEBDIR)/images
>  
> +clean: local_clean
> +
> +local_clean:
> +	rm -f include/globals.inc
>  
>  #-----------------------------------------------------------------------------#
>  
> Index: w3/news/newsdb.inc
> ===================================================================
> RCS file: /home/mercury1/repository/w3/news/newsdb.inc,v
> retrieving revision 1.60
> diff -u -u -r1.60 newsdb.inc
> --- w3/news/newsdb.inc	13 Aug 2001 05:49:34 -0000	1.60
> +++ w3/news/newsdb.inc	8 Oct 2001 05:09:28 -0000
> @@ -282,7 +282,7 @@
>  "The Mercury debugger now includes support for interactive queries.
>  See the \"Interactive query commands\" subsection of the \"Debugger commands\"
>  section of the \"Debugging\" chapter of the
> -<A HREF=\"http://www.cs.mu.oz.au/research/mercury/information/doc/user_guide_toc.html\">Mercury User's Guide</A>.  
> +<A HREF=\"http://www.cs.mu.oz.au/research/mercury/information/doc-latest/user_guide_toc.html\">Mercury User's Guide</A>.  
>  "),
>  
>  
This URL should be rewritten so that it uses relative links rather than
a fixed URL.

Also I have installed the tool linkchecker on earth, you might want to
use it to make sure that you got all the links.

I would also suggest symlinking doc to doc-latest?  So that any outside
references to the old website still resolve.  However I believe that on
www.cs.mu.oz.au symlink following is turned off, so you might need to
make a copy of the doc-latest directory, or request that it is allowed
inside the Mercury web site.

Pete
--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------