Opened 6 years ago

Closed 18 months ago

#1662 closed defect (fixed)

FDO website documentation links broken

Reported by: tagru Owned by: sac@…
Priority: normal Milestone:
Component: Systems Admin Keywords:
Cc:

Attachments (1)

fdo_doc_link.PNG (12.4 KB) - added by jng 5 years ago.

Download all attachments as: .zip

Change History (33)

comment:1 Changed 6 years ago by neteler

This is a know and yet unsolved issue. Here my previous investigations which remained unanswered:

---------- Forwarded message ----------
From: Markus Neteler <neteler@osgeo.org>
Date: Mon, May 25, 2015 at 11:07 PM
Subject: Re: [SAC] FDO Documentation
To: System Administration Committee Discussion/OSGeo <sac@lists.osgeo.org>

Hello Paul,

On Tue, May 19, 2015 at 9:15 AM, Paul Fels wrote:
>
> Hello,
>
>
>
> The links at http://fdo.osgeo.org/documentation.html lead to errorpages (e.g. http://fdo.osgeo.org/files/fdo/docs/FDO_API_managed/index.htm) saying: You don't have permission to access  /files/fdo/docs/FET_TheEssentialFDO/index.html on this server. The response to my message using http://www.osgeo.org/contact was that I should send a message to this list, but I haven’t receive any response since posting the message on 20-02-2015. Please, could anyone let me know who to contact to solve this problem?


I have taken liberty to check this problem on the server.

web:/var/www/html/files#
lrwxrwxrwx  1 root      root  19 Mar 21  2014 fdo -> /var/www/webdav/fdo
lrwxrwxrwx  1 root      root  24 Mar 21  2014 mapguide -> /var/www/webdav/mapguide


Both links point to a non-existing directory, that's why.
I see that there was earlier discussion on this:
https://lists.osgeo.org/pipermail/sac/2015-January/005393.html

I guess that the FDO project members need to help. The files in
question I cannot find on the server.

I found also this old message:
https://lists.osgeo.org/pipermail/sac/2008-December/001615.html

There is in /osgeo/download/webdav/ only a subdir geotools/, though.

Maybe other SAC or especially FDO members know more?

Markus

comment:2 Changed 6 years ago by tagru

Hmm, that is very sad. Any idea where else to contact someone from the project?

comment:3 in reply to:  description Changed 6 years ago by neteler

Replying to tagru:

All Links on https://fdo.osgeo.org/documentation.html lead to a 403 Forbidden - Error.

E.g: http://fdo.osgeo.org/files/fdo/docs/FDO_API_managed/index.htm

As mentioned elsewhere in the ticket, the error 403 results from the fact that the respective directory is gone on the OSGeo server (gone for a while).

However, I found the material here:

https://web.archive.org/web/20120421043321/http://fdo.osgeo.org/files/fdo/docs/FDO_API_managed/index.htm

Perhaps a volunteer could retrieve it from there, and bundle it for SAC to restore the files?

comment:4 Changed 5 years ago by Jeff McKenna

After so long without documentation for the entire FDO project, I feel that we should update all of the broken links (listed at http://fdo.osgeo.org/documentation.html) to point to working links, suppled by the WayBack? service, such as https://web.archive.org/web/20120421043321/http://fdo.osgeo.org/files/fdo/docs/FDO_API_managed/index.htm). It is ugly, embarrassing, unstable, all that and more, but, at least the FDO community can function.

Can someone give my account permissions to edit fdo.osgeo.org ? I cannot login with my usual OSGeo id ("jmckenna") at http://fdo.osgeo.org/user

Thanks,

comment:5 Changed 5 years ago by EliL

I opened an FDO ticket to see if it attracts notice there. There are multiple people currently updating the source code (see revision log).

comment:6 Changed 5 years ago by Jeff McKenna

Thanks. But I know myself I've been asking about this for almost 2 years, so, let's give this until the end of the week, and if no action I will volunteer my time to place working links on fdo.osgeo.org

comment:7 Changed 5 years ago by jng

Hi,

I am a PSC member of both MapGuide/FDO.

This is an issue known to me for some time, but I am not able to do anything about because I do not have full admin access to fdo.osgeo.org. Autodesk have been pretty much MIA on any project/community management for MapGuide and FDO

I have the means to provide most of the missing API documentation (they are generated from the FDO source code via doxygen). Other missing information we can reverse-engineer from old PDF documentation artifacts if required.

But the root issue still remains, I am powerless (within the OSGeo infrastructure) to do anything about it.

What I said here can also partially apply to mapguide.osgeo.org as well. Though I have edit capabilities there, I do not have (whatever file share access permissions) required to push API documentation. That's why the MapGuide Web API reference (http://mapguide.osgeo.org/files/mapguide/docs/2.0/index.htm) has also been broken for a long time.

comment:8 Changed 5 years ago by strk

Jackie, I think as a PSC member you should have full access to the mapguide directory. MapGuide PSC: http://mapguide.osgeo.org/psc.html

Where can we read the FDO PSC composition ? This is a 404: https://fdo.osgeo.org/psc.html (linked from https://fdo.osgeo.org/licenceAndGovernance.html)

Jeff, I can login on fdo.osgeo.org (aka web.osgeo.org) and can see both you and me are in the sudo group, so once you login you should be able to do whatever you want there. According to the logs you did log in last on October 15, 2015.

The mapguide.osgeo.org and fdo.osgeo.org directories are both writeable by anyone in the "web" group. This group is currently composed by sbarnes,dreamil,kanhaiya,gupteshwar,tmitchell. I can add 'jng' there (and maybe we should review the other compositions) - or create a more specific "mapguide" group (would be to be preferred, IMHO).

But this ticket is about FDO so I'd ask Jackie to file a new ticket for mapguide, and whoever is in the FDO PSC to step up here.

comment:9 Changed 5 years ago by Jeff McKenna

@strk: I am referring to logging into the FDO plone instance, using https://fdo.osgeo.org/user I cannot log into that instance, using my OSGeo ID of 'jmckenna'. I can indeed ssh into the VM, but I am speaking of using https://fdo.osgeo.org/user into the Plone instance.

@strk can you log into https://fdo.osgeo.org/user and give my user account permissions?

Last edited 5 years ago by Jeff McKenna (previous) (diff)

comment:10 Changed 5 years ago by strk

I cannot login into https://fdo.osgeo.org/user either, and I don't know that system at all

comment:11 Changed 5 years ago by Jeff McKenna

yes, that is the issue indeed, no one has access to the system to manage the content (I believe it is Drupal, not Plone).

comment:12 Changed 5 years ago by strk

Time to break in and give the key to Jackie ?

comment:13 Changed 5 years ago by Jeff McKenna

Jackie yesterday I sent new connection details to you for fdo.osgeo.org Can you access it? I made you an administrator, "project owner" in Drupal language, so you should be able to fix all of the documentation links. Please let me know if you need any help.

comment:14 Changed 5 years ago by jng

Yes I was able to login. How does one upload files? Is there a guide you can point me to?

Basically I have to upload (any/every) missing static file content under http://fdo.osgeo.org/files/fdo/...

comment:15 Changed 5 years ago by Jeff McKenna

In that case maybe easiest if you email me the files and I can copy them there: jmckenna(at)osgeo(dot)org

comment:16 Changed 5 years ago by Jeff McKenna

Sorry, I don't have a process for all of this. That I was able to break into the Drupal system yesterday and create accounts for us was something. I work hands-on, 'git er dun', but if others have the exact proper steps please speak up. If not, let's not let this sit for another year, and just email the files and I'll try to tackle it and see if we can make it work somehow. Let me know.

comment:17 Changed 5 years ago by Jeff McKenna

Following the 'git er dun' method: to avoid asking, you can just create a new content page through Drupal, for every missing doc page, and paste in the html there through Drupal; then update the main docs page to the links to those new content pages. It isn't fancy but it will work.

Last edited 5 years ago by Jeff McKenna (previous) (diff)

comment:18 Changed 5 years ago by strk

Jackie, if I'm not mistaken you have SSH access to the fdo.osgeo.org machine, so you can use sftp or scp to upload files there. Do you know how to use those ?

comment:19 Changed 5 years ago by jng

Yes, I've used SCP to upload MapGuide binaries in the past.

I can see where I need to upload files to. I think I've got this.

comment:20 Changed 5 years ago by Jeff McKenna

I notice that the "Documentation" link in the left panel of fdo.osgeo.org now points to a missing page.

comment:21 Changed 5 years ago by jng

An update:

I had to do some fixes to doxygen configuration files so that the documentation would build properly.

I was able to scp into fdo.osgeo.org. I saw the place where static files would most likely probably be served from /var/www/drupal/sites/fdo.osgeo.org/files and tried to create a docs directory to extract the FDO API documentation to. Permission denied. No dice.

I could not find anything within the admin or content creation UI that lets me upload a series of static files into drupal's configured file system root.

For anyone else want to try and figure this one out. I uploaded a zip of the doxygen docs here: http://download.osgeo.org/mapguide/support/FDO_HTML_Docs.zip

The contents within that have to be linked from the documentation page once the proper directory to extract to can be found is as follows:

  • FDO_API/index.htm FDO C++ API reference
  • FDO_API_managed/index.htm FDO .NET API reference
  • Providers/GDAL/index.htm FDO GDAL Provider API reference
  • Providers/MySQL/index.htm FDO MySQL Provider API reference
  • Providers/MySQL_managed/index.htm FDO MySQL Provider .NET API reference
  • Providers/ODBC/index.htm FDO ODBC Provider API Reference
  • Providers/ODBC_managed/index.htm FDO ODBC Provider .NET API Reference
  • Providers/SDF/index.htm FDO SDF Provider API Reference
  • Providers/SHP/index.htm FDO SHP Provider API Reference
  • Providers/SHP_managed/index.htm FDO SHP Provider .NET API Reference
  • Providers/SQLServerSpatial/index.htm FDO SQL Server Provider API Reference
  • Providers/SQLServerSpatial_managed/index.htm FDO SQL Server Provider .NET API Reference
  • Providers/WMS/index.htm FDO WMS Provider API Reference
  • Providers/WMS_managed/index.htm FDO WMS Provider .net API Reference

This is a 190MB zip file with thousands of HTML files (obviously way too big to email). Manually having to create a drupal page for each file in here is not a practical option.

comment:22 Changed 5 years ago by strk

I've changed target directory permissions to allow writes from the web group and added you to that group, can you try again ?

comment:23 Changed 5 years ago by jng

@strk EXCELLENT! I can see the FDO API docs I just unzipped at: http://fdo.osgeo.org/sites/fdo.osgeo.org/files/docs/FDO_API/index.htm

I can fix the rest of the links now. Thanks.

comment:24 Changed 5 years ago by Jeff McKenna

cool, well done Jackie!!!!

comment:25 Changed 5 years ago by strk

Note that due to the default umask all the files uploaded by jng won't be overridable by others in the "web" group. It would be nice to fix this too, one day, but let's keep it for a different ticket...

comment:26 Changed 5 years ago by jng

I'm curious as to where https://fdo.osgeo.org/documentation.html is being linked from. Is this the broken link you're referring to @jmckenna?

The proper link is https://fdo.osgeo.org/content/documentation, and the "Documentation" links I've seen thus far do point to that correct URL.

comment:27 Changed 5 years ago by Jeff McKenna

  • goto https://fdo.osgeo.org/
  • look in left panel of that page, below the words "Releases"
  • click on that "Documentation" link in that "Releases" section
Last edited 5 years ago by Jeff McKenna (previous) (diff)

Changed 5 years ago by jng

Attachment: fdo_doc_link.PNG added

comment:28 Changed 5 years ago by jng

@jmckenna are you referring to the attached screenshot (fdo_doc_link.png)? That points to the correct https://fdo.osgeo.org/content/documentation for me.

comment:29 Changed 5 years ago by strk

I notice a FOSS4G 2012 banner which would be nice to replace with a 2017 one :)

http://2017.foss4g.org/images/header.png

(not available in https yet, see #1798)

comment:30 Changed 5 years ago by Jeff McKenna

Jackie, my browser had cached the old link it seems. At some point recently it must have been changed. Please ignore my comment, fixed! :)

comment:31 Changed 5 years ago by Jeff McKenna

Indeed, if you google "FDO Documentation" the first result is the missing page: http://fdo.osgeo.org/documentation.html Could we setup a redirect to the 'new'/working page??

comment:32 Changed 18 months ago by robe

Resolution: fixed
Status: newclosed

Looks like this has changed and this is the new page - http://fdo.osgeo.org/content/documentation

and is picked up by gogle.

Note: See TracTickets for help on using tickets.