-
Notifications
You must be signed in to change notification settings - Fork 46
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Doc] reorganize integrator guide #3203
Changes from 6 commits
e76ef28
c7049f9
2d32486
b587d5f
7331a6a
790d797
f305f5f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,12 +27,6 @@ | |
/doc/administrator/administrate.rst | ||
/doc/developer/client_side.rst | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. to be removed ... There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes, thanks (next commit) |
||
/doc/index.rst | ||
/doc/integrator/legacy_cgxp.rst | ||
/doc/integrator/editing.rst | ||
/doc/integrator/features.rst | ||
/doc/integrator/fulltext_search.rst | ||
/doc/integrator/print.rst | ||
/doc/integrator/upgrade_application.rst | ||
/dist/ | ||
/coverage.xml | ||
/gatling/.classpath | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -47,7 +47,7 @@ Dependencies | |
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we put ngeo before cgxp, anf mark cgxp as legacy? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ok done (for next commit) |
||
Major dependencies docs: | ||
|
||
* `CGXP <http://docs.camptocamp.net/cgxp/${main_version}/>`_ | ||
* `CGXP <http://docs.camptocamp.net/cgxp/2.2/>`_ | ||
* `GXP <http://gxp.opengeo.org/master/doc/>`_ | ||
* `GeoExt <http://dev.geoext.org/geoext/docs/lib/>`_ | ||
* `OpenLayers <http://dev.openlayers.org/apidocs/files/OpenLayers-js.html>`_ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
.. _configuration_guide: | ||
|
||
Configuration Guide for advanced settings | ||
----------------------------------------- | ||
|
||
This chapter describes advanced configuration settings. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
make | ||
ngeo | ||
backend | ||
caching | ||
cluster | ||
filter | ||
fulltext_search | ||
internationalization | ||
shortener | ||
subdomain | ||
tilegeneration | ||
windows_tools |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
.. _integrator_features: | ||
|
||
Additional features | ||
=================== | ||
|
||
This section describes how to add features to a c2cgeoportal project, | ||
and configure them. | ||
|
||
Features that require additional steps (most of the time): | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
ngeo | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Legacy There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Which one is legacy here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ??? I'm tied :-) |
||
object_editing | ||
raster | ||
api | ||
reset_password | ||
intranet | ||
urllogin | ||
pdfreport |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,5 @@ | ||
.. _integrator_functionality: | ||
|
||
Customizing the Application using Functionalities | ||
================================================= | ||
Functionalities | ||
--------------- | ||
|
||
c2cgeoportal provides the concept of *functionality* that can be used to customize | ||
the application according to the user's permissions. | ||
|
@@ -25,10 +23,8 @@ the ``user`` database table, then the ``functionalities:anonymous`` and | |
``functionalities:registered`` configuration variables, as well as any | ||
functionality associated with his/her role, will be ignored. | ||
|
||
.. _integrator_functionality_configuration: | ||
|
||
Configuration | ||
------------- | ||
~~~~~~~~~~~~~ | ||
|
||
The ``vars_<project>.yaml`` file includes variables for managing *functionalities*. | ||
|
||
|
@@ -95,10 +91,10 @@ The ``vars_<project>.yaml`` file includes variables for managing *functionalitie | |
then the ``functionality`` template variable will be set to a dict with one | ||
key/value pair: ``"<functionality_name>": ["value1","value2"]``. | ||
|
||
Using Functionalities in Templates | ||
---------------------------------- | ||
Usage in Templates | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
As explained in the :ref:`integrator_functionality_configuration` section above, | ||
As explained in the configuration section above, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why removing the link? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Actually, purely for rst-technical reasons. Because the file functionality is now included by the file customisation, there is a otherwise a warning about duplicate labels - the html is generated fine anyway, but Travis will fail if I leave this warning. |
||
a functionality can be used in the Mako templates as long as it has been | ||
enabled using the ``functionalities:available_in_templates`` parameter in the | ||
``vars_<project>.yaml`` configuration file. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,5 @@ | ||
.. _integrator_https: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why removing that? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This label is not used, so I simply removed it (to avoid warnings - see above) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ok |
||
|
||
HTTPS | ||
===== | ||
----- | ||
|
||
If your application is accessed in HTTPS, you have to make sure that all URLs | ||
generated by the application (CSS and Javascript files, images, MapServer | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,5 +7,6 @@ Legacy components | |
:maxdepth: 1 | ||
|
||
legacy_cgxp | ||
legacy_editing | ||
legacy_print | ||
legacy_advanced |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to be removed ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, thanks (next commit)