Skip to content

Commit ce72e51

Browse files
MariekeGOMariekeGO
committed
descriptions for SEO + removal mini-TOCs
1 parent 4e45607 commit ce72e51

File tree

37 files changed

+38
-47
lines changed

37 files changed

+38
-47
lines changed

‎CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: contributing
3+
description: The DataMiner documentation is open to contributions from any user. Contributions are created, reviewed, and merged via GitHub.
34
---
45

56
# Contributing to the DataMiner docs

‎dataminer-overview/General Introduction/About_Skyline/Overview_About_Skyline.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Overview_About_Skyline
3+
description: With headquarters in Belgium but present across the globe, Skyline Communications is the global leader in end-to-end digital transformation solutions.
34
---
45

56
# About Skyline Communications

‎dataminer-overview/Pricing/Pricing_Commercial_Models.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Pricing_Commercial_Models
3+
description: DataMiner is available in two commercial models, i.e. perpetual-use licenses or usage-based services, combined with your preferred deploy model.
34
---
45

56
# Commercial & deploy models summary

‎develop/TOOLS/DIS/Introduction.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Overall_concept_of_the_DataMiner_Integration_Studio
3+
description: The free DIS Visual Studio extension allows you to import, create, and deploy connectors to establish connections between DataMiner and data sources.
34
---
45

56
# About DataMiner Integration Studio

‎develop/TOOLS/ThirdPartyTools/dnSpy.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: dnSpy
3+
description: With the dnSpy tool, you can debug any assembly when developing DataMiner Automation scripts or connectors, even without the matching code.
34
---
45

56
# dnSpy
@@ -19,6 +20,7 @@ To use this tool to debug Automation scripts or QActions on a remote system, fol
1920
1. Select *Debug > Attach to Process*, and select the process you want to debug (e.g. *SLAutomation.exe*, *SLScripting.exe*).
2021

2122
1. Select *Debug > Windows > Modules*, and sort by timestamp in descending order to find the right module.
23+
2224
This can be tricky, because every time you upload an Automation script or protocol, new assemblies are built, but the old ones remain in memory.
2325

2426
> [!NOTE]

‎develop/codingguidelines/CodingGuidelines.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: CodingGuidelines
3+
description: To uphold the quality level of DataMiner protocols and improve readability, maintainability, and performance, adhere to these best practices.
34
---
45

56
# Best practices for protocol development

‎develop/devguide/ClassLibrary/ClassLibraryIntroduction.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: ClassLibraryIntroduction
3+
description: The Skyline.DataMiner.Core.DataMinerSystem namespace defines types you can use to implement DataMiner-related logic in protocols and scripts.
34
---
45

56
# Class library introduction

‎develop/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ description: Discover all the information you need as a DataMiner Developer, fro
1919

2020
<div class="row">
2121
<div class="column">
22-
<a href="/develop/webservices/WS_v1/WS_v1.html" title="Web Services" target="_self"><img src="~/develop/images/Web_Services.svg" style="width:100%"></a>
22+
<a href="/develop/webservices/WS_v1/WS_About_v1/Using_the_Web_Services_v1.html" title="Web Services" target="_self"><img src="~/develop/images/Web_Services.svg" style="width:100%"></a>
2323
</div>
2424
<div class="column">
2525
<a href="/develop/CICD/CICD.html" title="CI/CD" target="_self"><img src="~/develop/images/CICD.svg" style="width:100%"></a>

‎develop/toc.yml

-3
Original file line numberDiff line numberDiff line change
@@ -3921,7 +3921,6 @@ items:
39213921
- name: Web Services
39223922
items:
39233923
- name: Web Services (v1)
3924-
topicUid: WS_v1
39253924
items:
39263925
- name: Using the Web Services (v1)
39273926
items:
@@ -5118,10 +5117,8 @@ items:
51185117
- name: DMAVisioRegionAction
51195118
topicUid: DMAVisioRegionAction
51205119
- name: Web Services (v0)
5121-
topicUid: WS_v0
51225120
items:
51235121
- name: About the Web Services (v0)
5124-
topicUid: WS_About_v0
51255122
items:
51265123
- name: Using the Web Services (v0)
51275124
topicUid: Using_the_Web_Services_v0

‎develop/webservices/WS_v0/WS_About_v0/Using_the_Web_Services_v0.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ uid: Using_the_Web_Services_v0
44

55
# Using the Web Services (v0)
66

7+
> [!WARNING]
8+
>
9+
> - From DataMiner 10.2.0/10.1.6 onwards, the Web Services API v0 is considered **obsolete**. By default, the v0 interface is disabled from these DataMiner versions onwards. However, you can enable the v0 interface again, provided that your DMS is not connected to dataminer.services. To do so, in the file *C:\\Skyline DataMiner\\Webpages\\API\\Web.config*, add the following extra tag under \<appSettings>: *\<add key="enableLegacyV0Interface" value="true"/>*
10+
> - We strongly recommend that you use HTTPS when accessing the Web Service APIs over public Internet. If you do not do so, all information – including logon credentials – will be sent over the Internet as plain, unencrypted text.
11+
712
1. Load the WSDL file.
813

914
See [Interfaces and WSDL files](xref:Interfaces_and_WSDL_filesv0).
@@ -19,10 +24,5 @@ uid: Using_the_Web_Services_v0
1924

2025
For a list of available methods, see [Methods (v0)](xref:WS_Methods_v0#methods-v0).
2126

22-
> [!WARNING]
23-
>
24-
> - From DataMiner 10.2.0/10.1.6 onwards, the Web Services API v0 is considered **obsolete**. By default, the v0 interface is disabled from these DataMiner versions onwards. However, you can enable the v0 interface again, provided that your DMS is not connected to dataminer.services. To do so, in the file *C:\\Skyline DataMiner\\Webpages\\API\\Web.config*, add the following extra tag under \<appSettings>: *\<add key="enableLegacyV0Interface" value="true"/>*
25-
> - We strongly recommend that you use HTTPS when accessing the Web Service APIs over public Internet. If you do not do so, all information – including logon credentials – will be sent over the Internet as plain, unencrypted text.
26-
2727
> [!NOTE]
2828
> In order to make a web API request from an external machine using HTTP POST instead of SOAP, uncomment the following section in the file *web.config* in the folder *C:\\Skyline DataMiner\\Webpages\\API*:<br><br> \<!-- uncomment to test webservices outside localhost:<br> \<protocols><br> \<add name="HttpGet"/><br> \<add name="HttpPost"/><br> \</protocols><br> //-->

‎develop/webservices/WS_v0/WS_About_v0/WS_About_v0.md

-11
This file was deleted.

‎develop/webservices/WS_v0/WS_v0.md

-14
This file was deleted.

‎develop/webservices/WS_v1/WS_v1.md

-11
This file was deleted.

‎user-guide/Advanced_Functionality/Advanced_Functionality.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Part3AdvancedFunctionalities
3+
description: Discover everything you need to know as a DataMiner administrator, from the basic setup of your system to the most complex configurations.
34
---
45

56
# Advanced DataMiner functionality for administrators

‎user-guide/Advanced_Functionality/DataMiner_Agents/Upgrading_a_DMA/Upgrading_a_DataMiner_Agent_in_System_Center.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Upgrading_a_DataMiner_Agent_in_System_Center
3+
description: Go to 'System Center' > 'Agents' > 'Manage', and click 'Upgrade'. Make sure you upgrade all DataMiner Agents in a DMS to the same version.
34
---
45

56
# Upgrading a DataMiner Agent in System Center

‎user-guide/Advanced_Functionality/DataMiner_Agents/Upgrading_a_DMA/Upgrading_a_DataMiner_Agent_in_the_Update_Center.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Upgrading_a_DataMiner_Agent_in_the_Update_Center
3+
description: Select 'Check for updates' in the Cube user icon menu, authenticate, go to the 'software' tab, download the right upgrade, and then click 'Upgrade'.
34
---
45

56
# Upgrading a DataMiner Agent in the Update Center

‎user-guide/Advanced_Functionality/DataMiner_Agents/Upgrading_a_DMA/Upgrading_a_DataMiner_Agent_using_DataMiner_Taskbar_Utility.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Upgrading_a_DataMiner_Agent_using_DataMiner_Taskbar_Utility
3+
description: Right-click the DataMiner Taskbar Utility icon and click 'Upgrade'. Make sure you upgrade all DataMiner Agents in a DMS to the same version.
34
---
45

56
# Upgrading a DataMiner Agent using DataMiner Taskbar Utility

‎user-guide/Advanced_Functionality/DataMiner_Agents/Upgrading_a_DataMiner_Agent.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Upgrading_a_DataMiner_Agent
3+
description: Once your system meets the necessary requirements and you have prepared the upgrade successfully, you can upgrade DataMiner in various ways.
34
---
45

56
# Upgrading a DataMiner Agent

‎user-guide/Advanced_Functionality/DataMiner_Systems/Sharing_DataMiner_data_with_third_parties.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ DataMiner Sharing allows you to share live data via dataminer.services. For more
5757
> See also:
5858
>
5959
> - [DataMiner interfaces](xref:DataMiner_interfaces)
60-
> - [Web Services](xref:WS_v1)
60+
> - [Web Services](xref:Using_the_Web_Services_v1)
6161
6262
## DataMiner Replication
6363

‎user-guide/Advanced_Functionality/Databases/Supported_System_Data_Storage_Architectures.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Supported_system_data_storage_architectures
3+
description: Aside from the recommended Storage as a Service (STaaS) data storage architecture, you can also use DataMiner with dedicated clustered storage.
34
---
45

56
# Supported system data storage architectures

‎user-guide/Advanced_Functionality/Security/About_DMS_Security/Cloud_connectivity_and_security.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Cloud_connectivity_and_security
3+
description: Security is built into the core design of the DataMiner Cloud Connectivity framework, so you can securely access the wealth of cloud features.
34
---
45

56
# Cloud connectivity and security

‎user-guide/Advanced_Functionality/Security/DataMiner_user_permissions.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: DataMiner_user_permissions
3+
description: With the user permissions in the Cube System Center, you can fine-tune which users and groups have access to specific DataMiner functionality.
34
---
45

56
# DataMiner user permissions

‎user-guide/Advanced_Modules/Advanced_Modules.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Part4AdvancedModules
3+
description: A DataMiner System can have several additional modules or apps, e.g. Automation, Dashboards, etc. Some require a specific type of DataMiner license.
34
---
45

56
# DataMiner modules

‎user-guide/Advanced_Modules/Dashboards_and_Low_Code_Apps/GQI/Extensions/Configuring_an_ad_hoc_data_source_in_a_query.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Configuring_an_ad_hoc_data_source_in_a_query
3+
description: For an ad hoc data source, add a correctly configured script in the Automation app and select 'Get ad hoc data' and your source in the query config.
34
---
45

56
# Configuring an ad hoc data source in a query

‎user-guide/Basic_Functionality/Visio/getting_started/Working_with_shape_data_in_Microsoft_Visio.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Working_with_shape_data_in_Microsoft_Visio
3+
description: In Microsoft Visio, use the Shape Data pane to add data fields to pages, shapes, or groups of shapes to enrich drawings with DataMiner functionality.
34
---
45

56
# Working with shape data in Microsoft Visio

‎user-guide/Basic_Functionality/Visio/miscellaneous/Extended_conditional_shape_manipulation_actions.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Extended_conditional_shape_manipulation_actions
3+
description: To apply conditional shape manipulation actions, configure the correct shape data field (e.g. Blink, Enabled, Hide, etc.) and enter the condition.
34
---
45

56
# Extended conditional shape manipulation actions

‎user-guide/Basic_Functionality/Visio/reference/Overview_of_page_and_shape_options.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Overview_of_page_and_shape_options
3+
description: When you configure shape data in Visio to enrich a drawing with DataMiner functionality, you can add many different options to pages or shapes.
34
---
45

56
# Overview of page and shape options

‎user-guide/Basic_Functionality/Visio/reference/Placeholders_for_variables_in_shape_data_values.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Placeholders_for_variables_in_shape_data_values
3+
description: In shape data values in Visio, you can use different placeholders. Among many others, this includes the keywords from Info shape data fields.
34
---
45

56
# Placeholders for variables in shape data values

‎user-guide/Cloud_Platform/Connecting_to_cloud/Connect_to_cloud_requirements.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Connect_to_cloud_requirements
3+
description: Use at least DataMiner 10.1.12, make sure the necessary endpoints can be reached, and allow HTTPS traffic via port TCP 5100 on the internal network.
34
---
45

56
# Requirements for connection to dataminer.services

‎user-guide/Getting_started/Accessing_DataMiner/Accessing_DataMiner_Cube/Installing_DataMiner_Cube/Installing_configuring_the_DataMiner_Cube_software.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Installing_configuring_the_DataMiner_Cube_software
3+
description: To use the DataMiner Cube desktop application, browse to the IP or name of your DMA using a modern browser and download Cube from the landing page.
34
---
45

56
# Installing & configuring the DataMiner Cube software

‎user-guide/Getting_started/Creating_a_DMS_in_the_cloud.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Creating_a_DMS_in_the_cloud
3+
description: With DaaS, you can create a complete DataMiner System in no time, fully hosted in the cloud, allowing easy scaling both vertically and horizontally.
34
---
45

56
# Creating a DataMiner System in the cloud (DaaS)

‎user-guide/Getting_started/Interacting_with_DataMiner/Client_apps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Several client apps are available that allow you to interact with a DataMiner Sy
1414

1515
![dataminer.services home page](~/user-guide/images/Accessing_Client_Apps.png)<br>*[dataminer.services](https://dataminer.services/) home page*
1616

17-
In addition to this, many [tools](xref:DataminerTools) are available, such as the [Alerter app](xref:Accessing_Alerter) to get alarm notifications on your desktop, or the [DataMiner&nbsp;Taskbar Utility](xref:Accessing_the_DataMiner_Taskbar_Utility) for DataMiner administrators, and it is also possible to interact with DataMiner via the [DataMiner Web APIs](xref:WS_v1).
17+
In addition to this, many [tools](xref:DataminerTools) are available, such as the [Alerter app](xref:Accessing_Alerter) to get alarm notifications on your desktop, or the [DataMiner&nbsp;Taskbar Utility](xref:Accessing_the_DataMiner_Taskbar_Utility) for DataMiner administrators, and it is also possible to interact with DataMiner via the [DataMiner Web APIs](xref:Using_the_Web_Services_v1).
1818

1919
## DataMiner Cube
2020

‎user-guide/Getting_started/Interacting_with_DataMiner/DataMiner_modules.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: DataMiner_modules
3+
description: A DataMiner System can have several additional modules or apps, e.g. Automation, Dashboards, etc. Some require a specific type of DataMiner license.
34
---
45

56
# DataMiner modules

‎user-guide/Getting_started/ZiineDemoSystem/ZiineDemoSystem.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: ZiineDemoSystem
3+
description: Use the Ziine Demo System to explore DataMiner features in a functioning DataMiner System. To connect, you need a dataminer.services account.
34
---
45

56
# Ziine Demo System

‎user-guide/Reference/DataMiner_Client_Requirements.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: DataMiner_Client_Requirements
3+
description: To run the DataMiner Cube client application, a recent Windows OS is required, on a system with sufficient CPU and (graphics) memory.
34
---
45

56
# DataMiner Client Requirements

‎user-guide/Reference/DataMiner_Tools/SLLogCollector.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: SLLogCollector
3+
description: SLLogCollector is available by default on each DataMiner Agent, allowing easy log and memory dump collection to troubleshoot DataMiner issues.
34
---
45

56
# SLLogCollector

‎user-guide/Troubleshooting/Procedures/Cloud_Connection_Issues.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
uid: Cloud_Connection_Issues
3+
description: In the specified order, check the connection status on dataminer.services, the status of the DMS, the CloudGateway status, and the cloud session.
34
---
45

56
# Investigating dataminer.services connection issues

0 commit comments

Comments
 (0)