Skip to content

Commit

Permalink
Deployed a402051 to master with MkDocs 1.4.2 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jan 31, 2024
1 parent 79d9258 commit 1af3701
Show file tree
Hide file tree
Showing 21 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion master/QuickStart/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ <h2 id="running-qwc2-as-part-of-qwc-services">Running QWC2 as part of qwc-servic
<pre><code class="language-bash">docker-compose up
</code></pre>
<p><em>Note</em>: If using the newer <code>docker compose</code> project, you need to write <code>docker compose up</code> instead of <code>docker-compose up</code> (and similarly for other <code>docker-compose</code> calls).</p>
<p><em>Note</em>: The sample <code>docker-compose-example.yml</code> uses <code>latest-lts</code> as image versions. It is recommended to replace these with a fix version tag when deploying the application to prevent docker from automatically pulling new versions when the application is launched, which may be undesired. See <a href="../configuration/ServiceConfiguration/#upgrading">Keeping QWC services up to date</a>.</p>
<p><em>Note</em>: The sample <code>docker-compose-example.yml</code> uses <code>latest-YYYY-lts</code> as image versions. It is recommended to replace these with a fix version tag when deploying the application to prevent docker from automatically pulling new versions when the application is launched, which may be undesired. See <a href="../configuration/ServiceConfiguration/#upgrading">Keeping QWC services up to date</a>.</p>
<p>The map viewer will run on <a href="http://localhost:8088/">http://localhost:8088/</a>.</p>
<p>The admin GUI will run on <a href="http://localhost:8088/qwc_admin">http://localhost:8088/qwc_admin</a> (default admin credentials: username <code>admin</code>, password <code>admin</code>, requires password change on first login).</p>
<p>Next steps:</p>
Expand Down
2 changes: 1 addition & 1 deletion master/configuration/ServiceConfiguration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ <h2 id="keeping-qwc-services-up-to-date">Keeping QWC services up to date<a name=
<li><code>vYYYY.X-lts</code>: These refer to the long term support version of the respective images (i.e. <code>v2023.1-lts</code>).</li>
</ul>
<p>You can always check the available tags on dockerhub, for example at <a href="https://hub.docker.com/r/sourcepole/qwc-config-generator">https://hub.docker.com/r/sourcepole/qwc-config-generator</a>.</p>
<p>In particular, to special tags exist, <code>latest</code> and <code>latest-lts</code> which always refer to the latest available "development" and long term support versions respectively. Note however that using these tags will result in docker automatically pulling new versions when the application is launched, which may be undesired.</p>
<p>In particular, to special tags exist, <code>latest</code>, <code>latest-lts</code> and <code>latest-YYYY-lts</code> (i.e. <code>latest-2024-lts</code>) which always refer to the latest available "development" and long term support versions respectively. Note however that using these tags will result in docker automatically pulling new versions when the application is launched, which may be undesired.</p>
<p>The <a href="../../release_notes/QwcDockerUpgradeNotes/"><code>qwc-docker</code> Upgrade Notes</a> documents major changes, and in particular all incompatible changes between releases which require changes to the application specific code and/or configuration.</p>

</div>
Expand Down
2 changes: 1 addition & 1 deletion master/references/qwc-admin-gui/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion master/references/qwc-config-generator/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion master/references/qwc-data-service/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion master/references/qwc-db-auth/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion master/references/qwc-elevation-service/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
<script src=https://use.fontawesome.com/facf9fa52c.js></script></p>
<script src=schema_doc.min.js></script>
<p><meta charset=utf-8><title>QWC Elevation Service</title></head> </p>
<body onload=anchorOnLoad(); id=root> <div class=breadcrumbs></div> <h1>QWC Elevation Service</h1><span class="badge badge-dark value-type">Type: object</span><br> <div class=accordion id=accordionschema> <div class=card> <div class=card-header id=headingschema> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#schema aria-expanded aria-controls=schema onclick="setAnchor('#schema')"><span class=property-name>$schema</span></button> </h2> </div> <div id=schema class="collapse property-definition-div" aria-labelledby=headingschema data-parent=#accordionschema> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#schema onclick="anchorLink('schema')">$schema</a></div><h4>JSON Schema</h4><span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: uri</span> <span class="badge badge-success default-value">Default: "https://raw.githubusercontent.com/qwc-services/qwc-elevation-service/master/schemas/qwc-elevation-service.json"</span><br> <span class=description><p>Reference to JSON schema of this config</p> </span> </div> </div> </div> </div> <div class=accordion id=accordionservice> <div class=card> <div class=card-header id=headingservice> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#service aria-expanded aria-controls=service onclick="setAnchor('#service')"><span class=property-name>service</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=service class="collapse property-definition-div" aria-labelledby=headingservice data-parent=#accordionservice> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#service onclick="anchorLink('service')">service</a></div><h4>Service name</h4><span class="badge badge-dark value-type">Type: const</span><br> <span class=const-value id=service_const>Specific value: <code>"elevation"</code></span> </div> </div> </div> </div> <div class=accordion id=accordionconfig> <div class=card> <div class=card-header id=headingconfig> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#config aria-expanded aria-controls=config onclick="setAnchor('#config')"><span class=property-name>config</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=config class="collapse property-definition-div" aria-labelledby=headingconfig data-parent=#accordionconfig> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#config onclick="anchorLink('config')">config</a></div><h4>Config options</h4><span class="badge badge-dark value-type">Type: object</span><br> <div class=accordion id=accordionconfig_elevation_dataset> <div class=card> <div class=card-header id=headingconfig_elevation_dataset> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#config_elevation_dataset aria-expanded aria-controls=config_elevation_dataset onclick="setAnchor('#config_elevation_dataset')"><span class=property-name>elevation_dataset</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=config_elevation_dataset class="collapse property-definition-div" aria-labelledby=headingconfig_elevation_dataset data-parent=#accordionconfig_elevation_dataset> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#config onclick="anchorLink('config')">config</a> <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#config_elevation_dataset onclick="anchorLink('config_elevation_dataset')">elevation_dataset</a></div><span class="badge badge-dark value-type">Type: string</span><br> <span class=description><p>Elevation dataset (file or URL). Example: https://data.sourcepole.com/srtm<em>1km</em>3857.tif</p> </span> </div> </div> </div> </div> </div> </div> </div> </div> <footer> <p class=generated-by-footer>Generated using <a href=https://github.com/coveooss/json-schema-for-humans>json-schema-for-humans</a> on 2024-01-31 at 14:48:56 +0000</p> </footer></body>
<body onload=anchorOnLoad(); id=root> <div class=breadcrumbs></div> <h1>QWC Elevation Service</h1><span class="badge badge-dark value-type">Type: object</span><br> <div class=accordion id=accordionschema> <div class=card> <div class=card-header id=headingschema> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#schema aria-expanded aria-controls=schema onclick="setAnchor('#schema')"><span class=property-name>$schema</span></button> </h2> </div> <div id=schema class="collapse property-definition-div" aria-labelledby=headingschema data-parent=#accordionschema> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#schema onclick="anchorLink('schema')">$schema</a></div><h4>JSON Schema</h4><span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: uri</span> <span class="badge badge-success default-value">Default: "https://raw.githubusercontent.com/qwc-services/qwc-elevation-service/master/schemas/qwc-elevation-service.json"</span><br> <span class=description><p>Reference to JSON schema of this config</p> </span> </div> </div> </div> </div> <div class=accordion id=accordionservice> <div class=card> <div class=card-header id=headingservice> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#service aria-expanded aria-controls=service onclick="setAnchor('#service')"><span class=property-name>service</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=service class="collapse property-definition-div" aria-labelledby=headingservice data-parent=#accordionservice> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#service onclick="anchorLink('service')">service</a></div><h4>Service name</h4><span class="badge badge-dark value-type">Type: const</span><br> <span class=const-value id=service_const>Specific value: <code>"elevation"</code></span> </div> </div> </div> </div> <div class=accordion id=accordionconfig> <div class=card> <div class=card-header id=headingconfig> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#config aria-expanded aria-controls=config onclick="setAnchor('#config')"><span class=property-name>config</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=config class="collapse property-definition-div" aria-labelledby=headingconfig data-parent=#accordionconfig> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#config onclick="anchorLink('config')">config</a></div><h4>Config options</h4><span class="badge badge-dark value-type">Type: object</span><br> <div class=accordion id=accordionconfig_elevation_dataset> <div class=card> <div class=card-header id=headingconfig_elevation_dataset> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#config_elevation_dataset aria-expanded aria-controls=config_elevation_dataset onclick="setAnchor('#config_elevation_dataset')"><span class=property-name>elevation_dataset</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=config_elevation_dataset class="collapse property-definition-div" aria-labelledby=headingconfig_elevation_dataset data-parent=#accordionconfig_elevation_dataset> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#config onclick="anchorLink('config')">config</a> <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#config_elevation_dataset onclick="anchorLink('config_elevation_dataset')">elevation_dataset</a></div><span class="badge badge-dark value-type">Type: string</span><br> <span class=description><p>Elevation dataset (file or URL). Example: https://data.sourcepole.com/srtm<em>1km</em>3857.tif</p> </span> </div> </div> </div> </div> </div> </div> </div> </div> <footer> <p class=generated-by-footer>Generated using <a href=https://github.com/coveooss/json-schema-for-humans>json-schema-for-humans</a> on 2024-01-31 at 17:40:45 +0000</p> </footer></body>
<p></html></p>

</div>
Expand Down
2 changes: 1 addition & 1 deletion master/references/qwc-ext-service/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion master/references/qwc-feature-info-service/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit 1af3701

Please sign in to comment.