[GeoNetwork-devel] Documentation edit 404 errors

Jo_Cook2 · June 7, 2019, 8:59am

Hi,

As part of the google season of docs initiative, I'm keen to get
people participating in improving and updating the geonetwork
documentation, but there's a big blocker in that the "edit on github"
links at the top of each page trigger 404 errors.

I have fixed this issue in some other sphinx-based documentation that
I look after that's actually hosted on ReadTheDocs, but I don't know
how to fix it in the case of the Geonetwork documentation. Can someone
help me with this?

Also as a warning, there might be some new documentation issues
appearing on github for areas of the documentation that people think
are missing, or need improvement. I am hoping to get some volunteer
technical writers, and perhaps even some time from the one paid
technical writer that OSGeo will be allocated to work on these.

Thanks

Jo

--
Jo Cook
t:+44 7930 524 155/twitter:@archaeogeek
Please note that currently I do not work on Friday afternoons. For
urgent responses at that time, please visit
support.astuntechnology.com or phone our office on 01372 744009

--
--
*Sign up to our mailing list
<https://astuntechnology.com/company/#email-updates> for updates on news,
products, conferences, events and training*
*
*

Astun Technology Ltd, The
Coach House, 17 West Street, Epsom, Surrey, KT18 7RL, UK
t:+44 1372 744
009 w: astuntechnology.com <http://astuntechnology.com/> twitter:@astuntech
<https://twitter.com/astuntech>

iShare - enterprise geographic
intelligence platform <https://astuntechnology.com/ishare/>
GeoServer,
PostGIS and QGIS training <https://astuntechnology.com/services/#training>

Helpdesk and customer portal
<http://support.astuntechnology.com/support/login>

Company registration
no. 5410695. Registered in England and Wales. Registered office: 120 Manor
Green Road, Epsom, Surrey, KT19 8LN VAT no. 864201149.

Francois_Prunayre · June 7, 2019, 9:17am

Great initiative Jo,

Indeed, it looks like it is not properly configured. They are pointing to

https://github.com/geosource-catalogue/doc/blob/develop/en/index.rst which get redirected but is not correct.

So in
https://github.com/geonetwork/doc/blob/develop/source/conf.py#L148
I would change:

‘github_user’: ‘geonetwork’,
‘github_repo’: ‘doc’,
‘github_version’: ‘develop’,
‘source_suffix’: ‘.rst’,
‘doc_path’: ‘source’,

So then it should be
https://github.com/geonetwork/doc/blob/develop/source/index.rst

I let you try ?

Then with the move to transifex, maybe we should only have this link on the english version.
But this is another thing to improve.

On this topic, I also handled the case a translation is not available and fallback to english. https://github.com/geonetwork/core-geonetwork/pull/3846 If you have time to review ?

Cheers.

Francois

Le ven. 7 juin 2019 à 11:00, Jo Cook <jocook@anonymised.com> a écrit :

Hi,

As part of the google season of docs initiative, I’m keen to get
people participating in improving and updating the geonetwork
documentation, but there’s a big blocker in that the “edit on github”
links at the top of each page trigger 404 errors.

I have fixed this issue in some other sphinx-based documentation that
I look after that’s actually hosted on ReadTheDocs, but I don’t know
how to fix it in the case of the Geonetwork documentation. Can someone
help me with this?

Also as a warning, there might be some new documentation issues
appearing on github for areas of the documentation that people think
are missing, or need improvement. I am hoping to get some volunteer
technical writers, and perhaps even some time from the one paid
technical writer that OSGeo will be allocated to work on these.

Thanks

Jo

–
Jo Cook
t:+44 7930 524 155/twitter:@archaeogeek
Please note that currently I do not work on Friday afternoons. For
urgent responses at that time, please visit
support.astuntechnology.com or phone our office on 01372 744009

–

Sign up to our mailing list
<https://astuntechnology.com/company/#email-updates> for updates on news,
products, conferences, events and training
*
*

Astun Technology Ltd, The
Coach House, 17 West Street, Epsom, Surrey, KT18 7RL, UK
t:+44 1372 744
009 w: astuntechnology.com <http://astuntechnology.com/> twitter:@astuntech
<https://twitter.com/astuntech>

iShare - enterprise geographic
intelligence platform <https://astuntechnology.com/ishare/>
GeoServer,
PostGIS and QGIS training <https://astuntechnology.com/services/#training>

Helpdesk and customer portal
<http://support.astuntechnology.com/support/login>

Company registration
no. 5410695. Registered in England and Wales. Registered office: 120 Manor
Green Road, Epsom, Surrey, KT19 8LN VAT no. 864201149.

GeoNetwork-devel mailing list
GeoNetwork-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geonetwork-devel
GeoNetwork OpenSource is maintained at http://sourceforge.net/projects/geonetwork

Jo_Cook2 · June 7, 2019, 9:33am

Hi Francois,

Sure, I'll test this locally first and review your change, probably on Monday.

Jo

On Fri, Jun 7, 2019 at 10:18 AM Francois Prunayre <fx.prunayre@anonymised.com> wrote:

Great initiative Jo,

Indeed, it looks like it is not properly configured. They are pointing to
https://github.com/geosource-catalogue/doc/blob/develop/en/index.rst which get redirected but is not correct.

So in
https://github.com/geonetwork/doc/blob/develop/source/conf.py#L148
I would change:

'github_user': 'geonetwork',
'github_repo': 'doc',
'github_version': 'develop',
'source_suffix': '.rst',
'doc_path': 'source',

So then it should be
https://github.com/geonetwork/doc/blob/develop/source/index.rst

I let you try ?

Then with the move to transifex, maybe we should only have this link on the english version.
But this is another thing to improve.

On this topic, I also handled the case a translation is not available and fallback to english. https://github.com/geonetwork/core-geonetwork/pull/3846 If you have time to review ?

Cheers.

Francois

Le ven. 7 juin 2019 à 11:00, Jo Cook <jocook@anonymised.com> a écrit :

Hi,

As part of the google season of docs initiative, I'm keen to get
people participating in improving and updating the geonetwork
documentation, but there's a big blocker in that the "edit on github"
links at the top of each page trigger 404 errors.

I have fixed this issue in some other sphinx-based documentation that
I look after that's actually hosted on ReadTheDocs, but I don't know
how to fix it in the case of the Geonetwork documentation. Can someone
help me with this?

Also as a warning, there might be some new documentation issues
appearing on github for areas of the documentation that people think
are missing, or need improvement. I am hoping to get some volunteer
technical writers, and perhaps even some time from the one paid
technical writer that OSGeo will be allocated to work on these.

Thanks

Jo

--
Jo Cook
t:+44 7930 524 155/twitter:@archaeogeek
Please note that currently I do not work on Friday afternoons. For
urgent responses at that time, please visit
support.astuntechnology.com or phone our office on 01372 744009

--
--
*Sign up to our mailing list
<https://astuntechnology.com/company/#email-updates> for updates on news,
products, conferences, events and training*
*
*

Astun Technology Ltd, The
Coach House, 17 West Street, Epsom, Surrey, KT18 7RL, UK
t:+44 1372 744
009 w: astuntechnology.com <http://astuntechnology.com/> twitter:@astuntech
<https://twitter.com/astuntech>

iShare - enterprise geographic
intelligence platform <https://astuntechnology.com/ishare/>
GeoServer,
PostGIS and QGIS training <https://astuntechnology.com/services/#training>

Helpdesk and customer portal
<http://support.astuntechnology.com/support/login>

Company registration
no. 5410695. Registered in England and Wales. Registered office: 120 Manor
Green Road, Epsom, Surrey, KT19 8LN VAT no. 864201149.

_______________________________________________
GeoNetwork-devel mailing list
GeoNetwork-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geonetwork-devel
GeoNetwork OpenSource is maintained at http://sourceforge.net/projects/geonetwork