[Live-demo] Enhancement for Version number in Online Documentation

[Frank Gasdorf]

2011/8/9 Alex Mandel <tech_dev at wildintellect.com>

> I have major concerns from a management perspective about not having
> version numbers in the files themselves. Especially with how many files
> get generated.
>

Alex, list

Just externalized the download size values for the 7z vm, iso and iso-mini
as well as the required hd space for running VirtualBox with ISO file.

values can be updated in settings.py (placed in doc folder)

updated download.rst files and added a Writing Tip on top.

Cheers, Frank


> We already have an odd issue (though not sure if it's just
> horders/spammers) where some of the older versions are still heavily
> downloaded. The title makes it obvious to an end user which version they
> have in case they come asking for help.
>
> Thanks,
> Alex
>
> On 08/09/2011 04:33 AM, Cameron Shorter wrote:
> > Frank,
> > As per one of your suggestions, I think that we are too close to 5.0
> > release, and as such shouldn't be introducing anything new like this
> > proposal. Lets come back and revisit for the next release.
> >
> > On 09/08/11 20:39, Frank Gasdorf wrote:
> >> Update on this:
> >>
> >> Replacement within target URLs for images isn't possible yet. I found
> >> an other solution but this would lead to images without links in the
> >> first step. And here is what I plan to do:
> >>
> >> 1. enable extension "sphinx.ext.extlinks" in conf.py :
> >>
> >>     extensions = [ 'sphinx.ext.extlinks' ]
> >>
> >>
> >> 2. define an extlink for the download area in conf.py :
> >>
> >>     base_download_release_url=
> >>
> >> '
> http://download.osgeo.org/livedvd/release/%(projectversion)s/%(variable)s
> >>
> >>
> >> <
> http://download.osgeo.org/livedvd/release/%%28projectversion%29s/%%28variable%29s
> >'
> >>
> >>     % { 'projectversion': version,'variable':'%s'}
> >>
> >>     extlinks = {
> >>
> >>         'osgeolive-download': (base_download_release_url, 'filename ')
> >>
> >>     }
> >>
> >>
> >> 3. usage in download.rst page:
> >>
> >>     [..]
> >>        .. image:: ../images/download_buttons/download-vm.png
> >>          :align: left
> >>
> >>     :osgeolive-download:`osgeo-live-vm.7z: <osgeo-live-vm.7z>`
> >>     (|osgeo-live-vm-7z-size|)
> >>     [..]
> >>
> >>
> >> 4. same procedure for the md5 files :
> >>
> >>      :osgeolive-download:`osgeo-live-vm.7z.md5 <osgeo-live-vm.7z.md5>`
> >>
> >>
> >> I would suggest to rename the files that the version number is not
> >> included anymore. The download area has the dynamic version number
> >> taken from the VERSION.txt file (for example:
> >> http://download.osgeo.org/livedvd/release/%(projectversion)s/
> >> <http://download.osgeo.org/livedvd/release/%%28projectversion%29s/>
> >> would lead into http://download.osgeo.org/livedvd/release/5.0/ if
> >>  VERSION.TXT has the line "5.0" in it )
> >>
> >> But in this case its necessary to change ISO naming procedure...
> >> Please have a look at the patch file coming along with this mail.
> >>
> >> pros:
> >>  * single point to define download URL's
> >>  * translators do not have to care about renaming
> >>  * no version update required in rst files anymore
> >> cons:
> >>  * update of shell scripts required for naming of ISO and 7z as well
> >> as md5 files (I have no chance to try the build with patched shell
> >> scripts)
> >>  * changes would be close to release day, maybe it's better to change
> >> after 5.0 release ...
> >>
> >> What do you think? Any opinions?
> >>
> >> Cheers, Frank
> >>
> >>
> >> 2011/7/7 Alex Mandel <tech_dev at wildintellect.com
> >> <mailto:tech_dev at wildintellect.com>>
> >>
> >>     On 07/07/2011 11:37 AM, Frank Gasdorf wrote:
> >>     > 2011/7/7 Alex Mandel <tech_dev at wildintellect.com
> >>     <mailto:tech_dev at wildintellect.com>>
> >>     >
> >>     >> Frank,
> >>     >>
> >>     >> No there is not a deployment script which uploads the ISOs,
> >>     it's much
> >>     >> more complicated than you think since that url is actually
> >>     redirected to
> >>     >> a tool that then sorts people's downloads amongst the 5 mirrors.
> >>     >>
> >>     >> The url as defined by the last release will be correct for the
> >> next
> >>     >> release.
> >>     >> Where:
> >>     >>
> >>     >>
> >>
> >>
> http://download.osgeo.org/livedvd/release/[version]/osgeo-live-[version].iso
> >>
> >>     >>
> >>     >>
> >>     >>
> >>
> >>
> http://download.osgeo.org/livedvd/release/[version]/osgeo-live-mini-[version].iso
> >>
> >>     >>
> >>     >>
> >>     >>
> >>
> >>
> http://download.osgeo.org/livedvd/release/[version]/osgeo-live-vm-[version].7z
> >>
> >>     >>
> >>     >> End up as:
> >>     >> http://download.osgeo.org/livedvd/release/5.0/osgeo-live-5.0.iso
> >>     >>
> >>     >> I'll just have to remember to stick to that naming convention
> >>     when I'm
> >>     >> making new versions
> >>     >>
> >>     >
> >>     > Correct me, when I'm wrong, I understood, that there is an
> >>     naming convention
> >>     > and if we use a pattern like the version replacement, we could
> >>     change the
> >>     > download.rst files in the way you summarized. So we don't have
> >>     to care about
> >>     > it in the future except the naming convention or uploading area
> >>     will change.
> >>     >
> >>     > Give me a go and I can update the download.rst files ...
> >>     >
> >>     > Cheers,
> >>     > Frank
> >>     >
> >>     >
> >>     >
> >>     Yes go ahead and make the change to create the links dynamically.
> >>     Those
> >>     are the correct naming conventions we intend to use. The url is
> >>     unlikely
> >>     to change in the foreseeable future aside from a new folder for each
> >>     version (which is accounted for in your method).
> >>
> >>     Thanks,
> >>     Alex
> >>
> >>
> >>
> >> _______________________________________________
> >> Live-demo mailing list
> >> Live-demo at lists.osgeo.org
> >> http://lists.osgeo.org/mailman/listinfo/live-demo
> >> http://wiki.osgeo.org/wiki/Live_GIS_Disc
> >
> >
> >
> >
> > _______________________________________________
> > Live-demo mailing list
> > Live-demo at lists.osgeo.org
> > http://lists.osgeo.org/mailman/listinfo/live-demo
> > http://wiki.osgeo.org/wiki/Live_GIS_Disc
>
> _______________________________________________
> Live-demo mailing list
> Live-demo at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/live-demo
> http://wiki.osgeo.org/wiki/Live_GIS_Disc
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/osgeolive/attachments/20110810/3fb8de6e/attachment.html>