Skip to content

Commit 7aa698a

Browse files
authored
Merge pull request #1168 from xcube-dev/clarasb-xxx-docs_viewer_page
Docs - Update Viewer App
2 parents 14a82d8 + f16ff11 commit 7aa698a

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
`https`, `ftp`, `reference`, `smos`, `stac`, `stac-cdse`, `stac-xcube`, `gedidb`,
77
`eopf-zarr`, `esa-cci-kc`.
88

9+
* Added link of xcube viewer documentation to `Viewer App` page in documentation.
910

1011
## Changes in 1.11.0
1112

docs/source/viewer.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
.. _`xcube viewer demo`: https://bc-viewer.brockmann-consult.de/
2-
.. _`xcube-viewer`: https://github.com/dcs4cop/xcube-viewer
3-
.. _`README`: https://github.com/dcs4cop/xcube-viewer/blob/master/README.md
1+
.. _`xcube Viewer demo`: https://bc-viewer.brockmann-consult.de/
2+
.. _`xcube-viewer`: https://github.com/xcube-dev/xcube-viewer
3+
.. _`README`: https://github.com/xcube-dev/xcube-viewer/blob/main/README.md
44
.. _`Euro Data Cube`: https://edc-viewer.brockmann-consult.de/
5+
.. _`documentation`: https://xcube-dev.github.io/xcube-viewer/
56

67
==========
78
Viewer App
89
==========
910

10-
The xcube viewer app is a simple, single-page web application to be used with the xcube server.
11+
The xcube Viewer app is a simple, single-page web application to be used with the xcube Server.
12+
For detailed information visit the `documentation`_.
1113

1214
Demo
1315
====
1416

15-
To test the viewer app, you can use the `xcube viewer demo`_. This is our Brockmann Consult Demo xcube viewer.
16-
Via the viewer's settings it is possible to change the xcube server url which is used for displaying data.
17+
To test the viewer app, you can use the `xcube Viewer demo`_. This is our Brockmann Consult Demo xcube Viewer.
18+
Via the viewer's settings it is possible to change the xcube Server url which is used for displaying data.
1719
To do so open the viewer's settings panels, select "Server". A "Select Server" panel is opened, click the "+"
1820
button to add a new server. Here is demo server that you may add for testing:
1921

@@ -24,7 +26,7 @@ button to add a new server. Here is demo server that you may add for testing:
2426
Functionality
2527
=============
2628

27-
The xcube viewer functionality is described exemplary using the `xcube viewer demo`_.
29+
The xcube Viewer functionality is described exemplary using the `xcube Viewer demo`_.
2830
The viewer visualizes data from the xcube datasets on top of a basemap.
2931
For zooming use the buttons in the top right corner of the map window or the zooming function of your
3032
computer mouse. A scale for the map is located in the lower right corner and in the
@@ -33,7 +35,7 @@ upper left corner a corresponding legend to the mapped data of the data cube is
3335
.. image:: _static/images/viewer/screenshot_overview.png
3436
:width: 800
3537

36-
A xcube viewer may hold several xcube datasets which you can select via the drop-down menu `Dataset`.
38+
A xcube Viewer may hold several xcube datasets which you can select via the drop-down menu `Dataset`.
3739
The viewed area automatically adjusts to a selected xcube dataset, meaning that if a newly selected
3840
dataset is located in a different region, the correct region is displayed on the map.
3941

@@ -131,7 +133,7 @@ hide lower values and it is possible to adjust the opacity.
131133
.. image:: _static/images/viewer/screenshot_colormap.png
132134
:width: 800
133135

134-
The xcube viewer app is constantly evolving and enhancements are added, therefore please be aware that the above
136+
The xcube Viewer app is constantly evolving and enhancements are added, therefore please be aware that the above
135137
described features may not always be completely up-to-date.
136138

137139
Build and Deploy

0 commit comments

Comments
 (0)