[Doc] reorganize integrator guide #3203
Conversation
jwkaltz
changed the title
|
Some files were not checked in (so the travis build fails) because a lot of doc files are listed in the .gitignore of the project... |
doc/developer/client_side.rst
Outdated
|
|
||
| The UI of c2cgeoportal applications is built from components of the CGXP | ||
| JavaScript library. This library is on GitHub: | ||
| https://github.com/camptocamp/cgxp. |
There was a problem hiding this comment.
No CGXP in master exempt in the Legacy chapter
There was a problem hiding this comment.
I have not looked yet at the developer guide. This PR is only about the integrator guide... I would prefer to do one step at a time.
doc/developer/client_side.rst
Outdated
| NGEO | ||
| ---- | ||
|
|
||
| link |
There was a problem hiding this comment.
Don't works on master (with Docker) ...
There was a problem hiding this comment.
see above (I have not looked yet at the developer guide. This PR is only about the integrator guide... I would prefer to do one step at a time.)
doc/index.rst
Outdated
| `with features grid <https://camptocamp.github.io/ngeo/2.3/examples/contribs/gmf/apps/desktop_alt/>`_, | ||
| to test the editing you can use the username 'demo' with the password 'demo'. | ||
|
|
||
| `ngeo (client) documentation <https://camptocamp.github.io/ngeo/2.3/apidoc/>`_. |
There was a problem hiding this comment.
all the 2.3 should be generated
There was a problem hiding this comment.
Yes - I added doc/index.rst by mistake (next commit will remove it - only .mako for this file, no changes in this PR for this part)
doc/integrator/editing.rst
Outdated
| .. _integrator_editing: | ||
|
|
||
| Editing (with CGXP) | ||
| =================== |
There was a problem hiding this comment.
In fact, this was already included only in Legacy section. But I will rename the file to make it more clear.
doc/integrator/features.rst
Outdated
| A c2cgeoportal project may define multiple viewers. By default a project | ||
| includes two viewers: the *main viewer* and the *editing viewer*. The main | ||
| viewer is defined in the ``<package>/templates/viewer.js`` file, while the | ||
| editing viewer is defined in the ``<package>/templates/edit.js`` file. Each |
There was a problem hiding this comment.
This conser CGXP and should be in legacy section ...
There was a problem hiding this comment.
Right, moving to legacy_cgxp
doc/integrator/print.rst
Outdated
| ===== | ||
|
|
||
| Adding the *print* feature to a c2cgeoportal project involves adding | ||
| a ``cgxp.plugins.Print`` plugin to the viewer, and configuring the MapFish |
There was a problem hiding this comment.
Right, moving this to legacy_cgxp.rst
doc/integrator/print.rst
Outdated
| be available in the user interface. | ||
|
|
||
| See the `Print API doc | ||
| <http://docs.camptocamp.net/cgxp/2.3/lib/plugins/Print.html>`_ for the |
There was a problem hiding this comment.
Now contained within legacy_cgxp file
| Using MapFish Print v3 | ||
| ---------------------- | ||
|
|
||
| Migration from the v2 |
There was a problem hiding this comment.
This should be done relay before the 2.3 upgrade ...
There was a problem hiding this comment.
OK, I will add a line to requirements.rst for this
doc/integrator/print.rst
Outdated
| * `Startup with Jasper Reports <http://mapfish.github.io/mapfish-print-doc/#/jasperReports>`_ | ||
|
|
||
|
|
||
| MapFish Print v2 configuration |
There was a problem hiding this comment.
I will move this section to legacy_print.rst
There was a problem hiding this comment.
It's not legacy, it don't works ...
There was a problem hiding this comment.
OK, then I simply remove this part
doc/integrator/print.rst
Outdated
| Spec attributes | ||
| ~~~~~~~~~~~~~~~ | ||
|
|
||
| With CGXP we have the following spec attributes: |
There was a problem hiding this comment.
right; I am moving this.
.gitignore
Outdated
| @@ -27,12 +27,6 @@ | |||
| /doc/administrator/administrate.rst | |||
There was a problem hiding this comment.
yes, thanks (next commit)
| @@ -47,7 +47,7 @@ Dependencies | |||
|
|
|||
There was a problem hiding this comment.
Can we put ngeo before cgxp, anf mark cgxp as legacy?
There was a problem hiding this comment.
ok done (for next commit)
.gitignore
Outdated
| @@ -27,12 +27,6 @@ | |||
| /doc/administrator/administrate.rst | |||
| /doc/developer/client_side.rst | |||
There was a problem hiding this comment.
yes, thanks (next commit)
For issue #3202.
With this pull request, I would like to suggest a first step of reorganization (navigation structure) of the integrator guide.
Once this is settled, I hope we can then think about moving / updating / inserting specific contents in an easier manner -> but that will be in additional PRs.