Geonode: Docs: Rework TOC

Created on 10 May 2019  路  9Comments  路  Source: GeoNode/geonode

@afabiani suggested to rework/cleanup the TOC. This issue is meant for discussion as part of the Docs Rework Milestone.

docs feature

Most helpful comment

Draft ToC pushed on the new-docs branch and compiled to _readthedocs_ http://docs.geonode.org/en/new-docs/

All 9 comments

It would be great if we can add some lines for use of qgis server backend https://github.com/GeoNode/geonode/issues/3932
@timlinux @lucernae

I have added the topics to the spreadsheet.
Please take a look and review, also add remarks at your convenience.
Feel free to change it also.

As soon as we agree on the TOC we can start working on the docs.
Thanks, everyone.

@afabiani one question. Do you plan to update old or replace docs completely with a new version? I would welcome the second as a fresh start.

@t-book I absolutely agree to replace it completely, even though whenever it's possible I would backport sections that are still valid and/or need just a refresh

+1

@t-book btw, I'm not an expert here, any suggestion is very welcomed.

@afabiani me neither :) IMHO it would be great to have a native speaker on board. At least to do a last proofreading. Also, I found some useful hints here: https://docness.readthedocs.io/en/latest/

Documentation should not contain list of commands. Scripts are made for that purpose.
For example https://docness.readthedocs.io/en/latest/external-channels/scripts.html

I do not fully agree but f.e. in case of apt packages installation a makefile could be an nice option.

I would definitly sign this:

Documentation has to be:
simple to read and understand
simple to create and maintain.
The best way to achieve this is to keep it minimal. So, make documentation straightforward.

https://docness.readthedocs.io/en/latest/keep-straightforward.html

Draft ToC pushed on the new-docs branch and compiled to _readthedocs_ http://docs.geonode.org/en/new-docs/

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jondoig picture jondoig  路  8Comments

sjohn-atenekom picture sjohn-atenekom  路  5Comments

audetrobergem picture audetrobergem  路  9Comments

malnajdi picture malnajdi  路  3Comments

frafra picture frafra  路  10Comments