Merge pull request #684 from jburel/doc_version

update url to point to the most recent documentation tag i.e. stable
ome · Dec 13, 2023 · df1b5a0 · df1b5a0
2 parents 5981746 + 8621a39
commit df1b5a0
Show file tree

Hide file tree

Showing 18 changed files with 48 additions and 48 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -14,7 +14,7 @@ <h1>Documentation</h1>
         <hr class="whitespace">
         <div class="row">
             <div class="small-12 medium-412 large-4 columns">
-                <a href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/" target="_blank" class="card-as-link">
+                <a href="https://omero.readthedocs.io/en/stable/" target="_blank" class="card-as-link">
                     <div class="card card-support">
                         <div class="card-section">
                             <div class="medium-2"><img class="thumbnail" alt="OMERO logo" src="{{ site.baseurl }}/img/logos/omero-logomark.svg"></div>

diff --git a/omero/developers/docs.html b/omero/developers/docs.html
@@ -14,7 +14,7 @@ <h3 class="header-blue">Documentation</h3>
 
         <div class="row small-up-12 medium-up-3">
             <div class="column">
-                <a href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/index.html" target="_blank">
+                <a href="https://omero.readthedocs.io/en/stable/developers/index.html" target="_blank">
                     <div class="card card-docs top-red">
                         <div class="card-section">
                             <h5 class="doc-title">OMERO developers documentation</h5>

diff --git a/omero/developers/getting-started.html b/omero/developers/getting-started.html
@@ -19,7 +19,7 @@ <h3 class="header-blue">Getting Started</h3>
                         <h4 class="text-center">Intro to working with OMERO</h4>
                         <i class="fa fa-book fa-5x icon-red"></i>
                         <p class="card-caption">This page summarizes the different aspects of OMERO - clients, server and data model as well as give some example database queries.</p>
-                        <div class="text-center"><a class="button small" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/GettingStarted.html" target="_blank">Read the Guide</a></div>
+                        <div class="text-center"><a class="button small" href="https://omero.readthedocs.io/en/stable/developers/GettingStarted.html" target="_blank">Read the Guide</a></div>
                     </div>
                 </div>
             </div>
@@ -29,7 +29,7 @@ <h4 class="text-center">Intro to working with OMERO</h4>
                         <h4 class="text-center">Installing OMERO from source</h4>
                         <i class="fa fa-book fa-5x icon-gray"></i>
                         <p class="card-caption">This page provides links to the source code and further information on working with it via Git and GitHub and how to build OMERO.</p>
-                        <div class="text-center"><a class="button small" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/installation.html" target="_blank">Read the Guide</a></div>
+                        <div class="text-center"><a class="button small" href="https://omero.readthedocs.io/en/stable/developers/installation.html" target="_blank">Read the Guide</a></div>
                     </div>
                 </div>
             </div>

diff --git a/omero/developers/index.html b/omero/developers/index.html
@@ -39,7 +39,7 @@ <h4>Open Source</h4>
             <div class="omero-key-feature-container medium-3 columns end">
                 <h4>Public API</h4>
                 <p>Work with your data in Python, Java, MATLAB and C++.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/index.html#using-the-omero-api" target="_blank">View Developer Guides</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/index.html#using-the-omero-api" target="_blank">View Developer Guides</a>
             </div>
         </div>
         <hr class="invisible">
@@ -48,15 +48,15 @@ <h4>Public API</h4>
             <div class="omero-key-feature-container medium-3 columns">
                 <h4>OMERO.web</h4>
                 <p>Use the OMERO.web framework to build web applications for OMERO.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/Web.html" target="_blank">View Developer Guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/Web.html" target="_blank">View Developer Guide</a>
                 <a class="button hollow tiny" href="{{ site.baseurl }}/omero/apps/">OMERO apps</a>
             </div>
             <div class="medium-1 columns"><img class="hide-for-small-only omero-feature-png thumbnail" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_blitz.png"></div>
             <div class="medium-1 columns"><img class="show-for-small-only omero-feature thumbnail" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_blitz.png"></div>
             <div class="omero-key-feature-container medium-3 columns end">
                 <h4>OMERO clients</h4>
                 <p>Develop Blitz clients that use the API and the Ice remoting framework.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/GettingStarted/AdvancedClientDevelopment.html" target="_blank">View Developer Guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/GettingStarted/AdvancedClientDevelopment.html" target="_blank">View Developer Guide</a>
             </div>
         </div>
         <hr class="invisible">
@@ -65,13 +65,13 @@ <h4>OMERO clients</h4>
             <div class="omero-key-feature-container medium-3 columns">
                 <h4>OMERO.cli</h4>
                 <p>Use the CLI to work with OMERO objects and write plugins.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/cli/index.html" target="_blank">View Developer Guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/cli/index.html" target="_blank">View Developer Guide</a>
             </div>
             <div class="medium-1 columns"><img class="omero-feature thumbnail" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_scripts.svg"></div>
             <div class="omero-key-feature-container medium-3 columns end">
                 <h4>Scripting Service</h4>
                 <p>Write Python scripts to add functionality to the OMERO.server. <a href="https://github.com/openmicroscopy/omero-example-scripts" target="_blank">Share your scripts</a> with the community.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/scripts/" target="_blank">View Developer Guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/scripts/" target="_blank">View Developer Guide</a>
             </div>
         </div>
         <hr class="invisible">
@@ -80,14 +80,14 @@ <h4>Scripting Service</h4>
             <div class="omero-key-feature-container medium-3 columns">
                 <h4>Analysis</h4>
                 <p>Save your analysis results to OMERO.server or use OMERO.tables to store columnar data.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/index.html#analysis" target="_blank">View Developer Guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/index.html#analysis" target="_blank">View Developer Guide</a>
                 <a class="button hollow tiny" href="{{ site.baseurl }}/omero/features/analyze/">Learn more about analysis integrations</a>
             </div>
             <div class="medium-1 columns"><img class="omero-feature thumbnail" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_server.svg"></div>
             <div class="omero-key-feature-container medium-3 columns end">
                 <h4>OMERO.server</h4>
                 <p>Extend the OMERO.server by writing your own services or using the OMERO.grid infrastructure to manage your own processes.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/Server/ExtendingOmero.html" target="_blank">View Developer Guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/Server/ExtendingOmero.html" target="_blank">View Developer Guide</a>
             </div>
         </div>
         <!-- end Key Features -->

diff --git a/omero/downloads/index.html b/omero/downloads/index.html
@@ -93,7 +93,7 @@ <h6>omero_ij-{{ site.omero.insight.version }}-all.jar</h6>
                         <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_matlab.svg">
                         <h5>MATLAB</h5>
                         <h6>OMERO.matlab-{{ site.omero.matlab.version }}.zip</h6>
-                        <p class="card-caption">View instructions at <a href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/Matlab.html" target="_blank">OMERO MATLAB language bindings</a>.</p>
+                        <p class="card-caption">View instructions at <a href="https://omero.readthedocs.io/en/stable/developers/Matlab.html" target="_blank">OMERO MATLAB language bindings</a>.</p>
                         <a href="https://github.com/ome/omero-matlab/releases/download/v{{ site.omero.matlab.version }}/OMERO.matlab-{{ site.omero.matlab.version }}.zip" class="button hollow small"><i class="fa fa-download"></i> Download (54 MB)</a>
                     </div>
                 </div>
@@ -104,7 +104,7 @@ <h6>OMERO.matlab-{{ site.omero.matlab.version }}.zip</h6>
                         <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_server.svg">
                         <h5>Server (Ice 3.6)</h5>
                         <h6>OMERO.server-{{ site.omero.version }}-ice36.zip</h6>
-                        <p class="card-caption">View installation guides in <a href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/sysadmins/index.html" target="_blank">System Administrator documentation</a>.</p>
+                        <p class="card-caption">View installation guides in <a href="https://omero.readthedocs.io/en/stable/sysadmins/index.html" target="_blank">System Administrator documentation</a>.</p>
                         <a href="https://github.com/ome/openmicroscopy/releases/download/v{{ site.omero.version }}/OMERO.server-{{ site.omero.version }}-ice36.zip" class="button hollow small"><i class="fa fa-download"></i> Download (260 MB)</a>
                     </div>
                 </div>
@@ -136,7 +136,7 @@ <h3 class="text-center">OMERO Java</h3>
                         <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_java.svg">
                         <h5>Java (Ice 3.6)</h5>
                         <h6>OMERO.java-{{ site.omero.version }}-ice36.zip</h6>
-                        <p class="card-caption">The OMERO Java documentation is available to read on the web <a href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/Java.html">here</a>.</p>
+                        <p class="card-caption">The OMERO Java documentation is available to read on the web <a href="https://omero.readthedocs.io/en/stable/developers/Java.html">here</a>.</p>
                         <a href="https://github.com/ome/openmicroscopy/releases/download/v{{ site.omero.version }}/OMERO.java-{{ site.omero.version }}-ice36.zip" class="button hollow small"><i class="fa fa-download"></i> Download (125 MB)</a>
                     </div>
                 </div>

diff --git a/omero/features/analyze/index.html b/omero/features/analyze/index.html
@@ -58,7 +58,7 @@ <h4>ImageJ/Fiji plugin</h4>
                 <h4>Scripting service</h4>
                 <p>Write scripts to add functionality to OMERO.server
                     and share them with the community.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/scripts/" target="_blank">View developer guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/scripts/" target="_blank">View developer guide</a>
                 <a class="button hollow tiny" href="https://www.youtube.com/watch?v=sKRvYVZksdM" target="_blank">View movie</a>
             </div>
             <div class="omero-feature-container tall-content column text-center">
@@ -94,7 +94,7 @@ <h4>R and OMERO</h4>
                 <h4>Tabular Data support</h4>
                 <p>HDF-based storage of measurement results with an API for
                     exporting to Excel using OMERO.tables.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/analysis.html#storing-external-data-in-omero" target="_blank">View developer guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/analysis.html#storing-external-data-in-omero" target="_blank">View developer guide</a>
             </div>
             <div class="omero-feature-container tall-content column text-center">
                 <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_matlab.svg">

diff --git a/omero/features/export/index.html b/omero/features/export/index.html
@@ -30,14 +30,14 @@ <h4>Export images</h4>
                 <h4>Export multi-image filesets</h4>
                 <p>Bio-Formats allows OMERO to recognize filesets and treat
                     them as one unit.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/ImportFS.html#filesets" target="_blank">View developer guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/ImportFS.html#filesets" target="_blank">View developer guide</a>
             </div>
             <div class="omero-feature-container column text-center">
                 <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_export-hcs.svg">
                 <h4>Export HCS data</h4>
                 <p>OMERO.server can be configured to allow plate
                     data to be downloaded.</p>
-                <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/sysadmins/config.html#omero-policy-binary-access" target="_blank">View sysadmin guide</a>
+                <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/sysadmins/config.html#omero-policy-binary-access" target="_blank">View sysadmin guide</a>
             </div>
         </div>
     </div>

diff --git a/omero/features/import/index.html b/omero/features/import/index.html
@@ -36,22 +36,22 @@ <h4>Supported file formats</h4>
                     <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_command-line.svg">
                     <h4>Command Line Import</h4>
                     <p>Use the command line to import images into OMERO.</p>
-                    <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/users/cli/import.html" target="_blank">View CLI guide</a>
+                    <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/users/cli/import.html" target="_blank">View CLI guide</a>
                     <a class="button hollow tiny" href="https://www.youtube.com/playlist?list=PL-oOCWFUMH53JcqG_Fi09NcG1zS2VC0cP" target="_blank">View movies</a>
                 </div>
                 <div class="omero-feature-container tall-content column text-center">
                     <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_star.svg">
                     <h4>Improved performance</h4>
                     <p>Stream-lined backend import process uploads large
                         datasets such as HCS and SPIM much faster.</p>
-                    <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/sysadmins/import-scenarios.html#parallel-import" target="_blank">View CLI guide</a>
+                    <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/sysadmins/import-scenarios.html#parallel-import" target="_blank">View CLI guide</a>
                 </div>
                 <div class="omero-feature-container tall-content column text-center">
                     <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_dropbox.svg">
                     <h4>OMERO.dropbox</h4>
                     <p>Allows automatic import from a defined directory of all
                         supported file formats.</p>
-                    <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/sysadmins/dropbox.html" target="_blank">View sysadmin guide</a>
+                    <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/sysadmins/dropbox.html" target="_blank">View sysadmin guide</a>
                 </div>
                 <div class="omero-feature-container tall-content column text-center">
                     <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_import-for.svg">
@@ -60,14 +60,14 @@ <h4>Import-For</h4>
                         users, which will then be owned by that other
                         user.</p>
                     <a class="button hollow tiny" href="https://omero-guides.readthedocs.io/en/latest/upload/docs/import-desktop-client.html#import-for-another-user" target="_blank">View user guide</a>
-                    <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/users/cli/import.html" target="_blank">View CLI guide</a>
+                    <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/users/cli/import.html" target="_blank">View CLI guide</a>
                 </div>
                 <div class="omero-feature-container tall-content column text-center">
                     <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_files.svg">
                     <h4>Original file formats</h4>
                     <p>OMERO.server now uploads, exports, and stores files in
                         their original file format.</p>
-                    <a class="button hollow tiny" href="https://docs.openmicroscopy.org/omero/{{ site.omero.version }}/developers/Server/FS.html" target="_blank">View developer guide</a>
+                    <a class="button hollow tiny" href="https://omero.readthedocs.io/en/stable/developers/Server/FS.html" target="_blank">View developer guide</a>
                 </div>
                 <div class="omero-feature-container tall-content column text-center">
                     <img class="thumbnail omero-feature" alt="OMERO feature" src="{{ site.baseurl }}/img/icons/omero-features-icons_integrity-reports.svg">