[GRASS-dev] Structure of links for addons, manual pages etc.

GRASS GIS GRASS GIS developer
1

Hi,

I think we need to rethink the structure of addresses/links to various things which we are putting online.

The motivation are discussions “Linking Addons manual pages to core modules”, “addons for windows”, and “Addon manual pages not linked”.

For example, so far we were linking the trunk documentation using grass70/manuals but since we forked the 70 branch these links now points to it and not to trunk. Also all general links to GRASS documentation leads to grass64/manuals but this will be soon very obsolete.

A lot of projects uses links such as latest, release or current (e.g. latest/manuals or release/manuals) which leads to the current (latest) release. And also links such as master, latest, trunk, nightly which leads to the one builds from the source code of the main branch. Alternatively, there is no special link for the current release which shortens URLs. I think something like this might be beneficial for us.

So far I identified this set of things:

  • GRASS binaries
  • addons for MS Windows
  • addons SVN
  • manual pages
  • programming manual (or manuals)

I don’t have any concrete suggestion now. What are your experiences with this?

Thanks,
Vaclav

http://lists.osgeo.org/pipermail/grass-dev/2014-April/068192.html

http://lists.osgeo.org/pipermail/grass-dev/2014-April/068193.html

http://lists.osgeo.org/pipermail/grass-web/2013-December/004587.html

2

About the manual urls, I have an opinion:

Main manual for G7 to be linked to the SVN version (always updated).

Old manuals fixed to released versions (not maintained).

I understand how extreme it may be, but it may be very easy to maintain (only one version)

0.02c

···

On 10 April 2014 07:21, Vaclav Petras <wenzeslaus@gmail.com> wrote:

Hi,

I think we need to rethink the structure of addresses/links to various things which we are putting online.

The motivation are discussions “Linking Addons manual pages to core modules”, “addons for windows”, and “Addon manual pages not linked”.

For example, so far we were linking the trunk documentation using grass70/manuals but since we forked the 70 branch these links now points to it and not to trunk. Also all general links to GRASS documentation leads to grass64/manuals but this will be soon very obsolete.

A lot of projects uses links such as latest, release or current (e.g. latest/manuals or release/manuals) which leads to the current (latest) release. And also links such as master, latest, trunk, nightly which leads to the one builds from the source code of the main branch. Alternatively, there is no special link for the current release which shortens URLs. I think something like this might be beneficial for us.

So far I identified this set of things:

  • GRASS binaries
  • addons for MS Windows
  • addons SVN
  • manual pages
  • programming manual (or manuals)

I don’t have any concrete suggestion now. What are your experiences with this?

Thanks,
Vaclav

http://lists.osgeo.org/pipermail/grass-dev/2014-April/068192.html

http://lists.osgeo.org/pipermail/grass-dev/2014-April/068193.html

http://lists.osgeo.org/pipermail/grass-web/2013-December/004587.html

grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

–

3

On Thu, Apr 10, 2014 at 3:51 AM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

Hi,

I think we need to rethink the structure of addresses/links to various
things which we are putting online.

The motivation are discussions "Linking Addons manual pages to core
modules", "addons for windows", and "Addon manual pages not linked".

For example, so far we were linking the trunk documentation using
grass70/manuals but since we forked the 70 branch these links now points to
it and not to trunk.

I fixed that some days ago:

http://grass.osgeo.org/grass71/manuals/
-> GRASS GIS 7.1.svn Reference Manual

subsequently we have:
http://grass.osgeo.org/grass70/manuals/
-> GRASS GIS 7.0.0svn Reference Manual

http://grass.osgeo.org/grass64/manuals/
-> GRASS GIS 6.4.4svn Reference Manual

I understand Yann's suggestion but it is nicer to tell a user "yes, I
uploaded your improvement and starting next Saturday you can see it
online". So I generate the "stable" manuals from the release branches.

Also all general links to GRASS documentation leads to
grass64/manuals

Do you have some examples for that? I am not sure which links.

but this will be soon very obsolete.

... soon means some years :slight_smile:

A lot of projects uses links such as latest, release or current (e.g.
latest/manuals or release/manuals) which leads to the current (latest)
release.

Would be a few minutes to add some links to the server.
But I am not sure if grass/release/manual/ increases clarity.

And also links such as master, latest, trunk, nightly which leads
to the one builds from the source code of the main branch. Alternatively,
there is no special link for the current release which shortens URLs. I
think something like this might be beneficial for us.

I would like to keep it simple. Many "normal" users will not know what
"master", "trunk" "nightly something" would mean at all. We should
keep this majority of people in mind.

So far I identified this set of things:

* GRASS binaries

http://grass.osgeo.org/download/software

* addons for MS Windows

http://grass.osgeo.org/download/addons/

* addons SVN

http://grass.osgeo.org/download/addons

* manual pages

http://grass.osgeo.org/documentation/manuals

* programming manual (or manuals)

http://grass.osgeo.org/programming6/
--> relbranch6

http://grass.osgeo.org/programming7/
--> trunk

cheers
Markus