Skip to content

Commit f4dbe31

Browse files
committed
connector help => documentation
Includes some corrections of conversion and pre-conversion issues.
1 parent 028c11c commit f4dbe31

20 files changed

+153
-175
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
uid: contributing_connectors
33
---
44

5-
# Contributing to the DataMiner connector help
5+
# Contributing to the DataMiner connector documentation
66

7-
For every connector that is developed for DataMiner, a corresponding help page should be available. These help pages are added to the [dataminer-docs-connectors](https://github.com/SkylineCommunications/dataminer-docs-connectors) GitHub repository.
7+
For every connector that is developed for DataMiner, a corresponding documentation page should be available. These pages are added to the [dataminer-docs-connectors](https://github.com/SkylineCommunications/dataminer-docs-connectors) GitHub repository.
88

9-
- For more information on how you can create such help pages, see [Connector help pages](https://docs.dataminer.services/develop/devguide/Connector/ConnectorHelp/Connector_help_pages.html)
9+
- For more information on how you can create such documentation pages, see [Connector documentation](https://docs.dataminer.services/develop/devguide/Connector/ConnectorHelp/Connector_help_pages.html)
1010

1111
- For more information on how to contribute to the DataMiner documentation in general, refer to [Contributing to the DataMiner docs](https://docs.dataminer.services/CONTRIBUTING.html).

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33

44
This repository contains the documentation for all DataMiner connectors.
55

6-
Want to contribute? See [Contributing to the DataMiner connector help](xref:contributing_connectors).
6+
Want to contribute? See [Contributing to the DataMiner connector documentation](xref:contributing_connectors).

connector_help/connector-help/Arris_E6000_Configuration_Manager.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Each row matches a CMTS, and on each row 3 buttons are available that trigger an
5858
- **Refresh**: Refreshes the config files.
5959
- **Refresh**: Refreshes the firmware files.
6060

61-
These operations are explained in detail in the Arris E6000 connector help, in the sections "Backup & Restore Config Page" and "Image Upgrade Page".
61+
These operations are explained in detail in the Arris E6000 connector documentation, in the sections "Backup & Restore Config Page" and "Image Upgrade Page".
6262

6363
The following additional buttons also allow actions on this table:
6464

@@ -92,7 +92,7 @@ For bulk operations on the elements of this table, several buttons are available
9292
- **Remove All**: Clears the table of all elements.
9393
- **Remove All From Queue**: Removes all the elements waiting to have the current operation executed. Note: Doing this only removes the elements from the queue of the bulk execution. Once the execution has started for an element, it cannot be stopped.
9494

95-
These operations are explained in detail in the Arris E6000 connector help, in the sections "Backup & Restore Config Page" and "Upload & Upgrade Page".
95+
These operations are explained in detail in the Arris E6000 connector documentation, in the sections "Backup & Restore Config Page" and "Upload & Upgrade Page".
9696

9797
**Current Operation Running** displays the operation that is running at the present moment. This can be Upload Firmware, Update Firmware, Commit, etc. or **None** if no operation is running at the moment.
9898

connector_help/connector-help/Axon_ACP_ERS10.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The Axon ACP ERS10 supports multiple firmware versions for multiple card types.
2828

2929
An overview of the supported card types can be found in the "Exported connectors" section.
3030

31-
The implemented firmware versions for each supported card type are described in the connector help's "Supported firmware versions" section of the related card.
31+
The implemented firmware versions for each supported card type are described in the documentation for these cards.
3232

3333
### Exported Connectors
3434

@@ -68,7 +68,7 @@ SERIAL CONNECTION:
6868

6969
- Direct connection:
7070

71-
- **Baudrate:** Baudrate specified in the manual of the device, e.g. *9600*.
71+
- **Baudrate:** Baudrate specified in the manual of the device, e.g. *9600*.
7272
- **Databits:** Databits specified in the manual of the device, e.g. *7*.
7373
- **Stopbits:** Stopbits specified in the manual of the device, e.g. *1*.
7474
- **Parity:** Parity specified in the manual of the device, e.g. *No*.

connector_help/connector-help/Axon_ACP_ERS11.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This connector supports multiple firmware versions for multiple card types.
2525

2626
An overview of the supported card types can be found in the "Exported connectors" section below.
2727

28-
The implemented firmware versions for each supported card type are described in the "Supported firmware versions" sections of the connector help pages of these cards.
28+
The implemented firmware versions for each supported card type are described in the documentation for these cards.
2929

3030
### Exported connectors
3131

@@ -66,16 +66,16 @@ SERIAL CONNECTION:
6666

6767
- Direct connection:
6868

69-
- **Baudrate:** Baudrate specified in the manual of the device, e.g. *9600*.
70-
- **Databits:** Databits specified in the manual of the device, e.g. *7*.
71-
- **Stopbits:** Stopbits specified in the manual of the device, e.g. *1*.
72-
- **Parity:** Parity specified in the manual of the device, e.g. *No*.
73-
- **FlowControl:** FlowControl specified in the manual of the device, e.g. *No*.
69+
- **Baudrate**: Baudrate specified in the manual of the device, e.g. *9600*.
70+
- **Databits**: Databits specified in the manual of the device, e.g. *7*.
71+
- **Stopbits**: Stopbits specified in the manual of the device, e.g. *1*.
72+
- **Parity**: Parity specified in the manual of the device, e.g. *No*.
73+
- **FlowControl**: FlowControl specified in the manual of the device, e.g. *No*.
7474

7575
- Interface connection:
7676

77-
- **IP address/host:** The polling IP of the device.
78-
- **IP port:**\[The IP port of the device. Default value: *2071*.
77+
- **IP address/host**: The polling IP of the device.
78+
- **IP port**: The IP port of the device. Default value: *2071*.
7979

8080
## Usage
8181

connector_help/connector-help/Beckhoff_BK9000.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ The Beckhoff BK9000 is a virtual connector that is used to provide information a
1010

1111
The connector provides an overview of the different modules and allows the user to edit module types. Via a virtual connection, the Beckhoff BK9000 provides other elements with position information. This includes the module type and start and stop position.
1212

13-
### connector range 2.0.0
14-
15-
This connector help describes the 2.0.0 range of the connector. In this range, it is possible to change the number of modules dynamically by using a table.
13+
This page describes the **2.0.0 range** of the connector. In this range, it is possible to change the number of modules dynamically by using a table.
1614

1715
## Installation and configuration
1816

connector_help/connector-help/CEFD_Memotec_NetPerformer_SDM9220-9230.md

+38-35
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,29 @@ The Memotec Netperformer SDM9220-9230 version is an SNMP connector intended to c
88

99
## About
1010

11-
This connector implements the available parameters present in the device's MIB. The connector layout is implemented as much as possible like the device's web interface. There are menus that are not 100% coincident.
11+
This connector implements the available parameters present in the device's MIB. The connector layout is implemented as much as possible like the device's web interface, although not all menus are exactly the same.
12+
1213
A **SNMP** connection is used in order to successfully retrieve and configure the device's information.
1314

14-
## Installation and configuration
15+
## Configuration
1516

16-
### Creation
17+
### Connections
1718

18-
**SNMP Connection:**
19+
#### SNMP Connection - Main
1920

20-
- **IP Address/host:** \[*The polling IP of the device.*\]
21+
This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
2122

22-
**SNMP Settings:**
23+
SNMP CONNECTION:
2324

24-
- **Port Number:** \[*The port of the connection device (default: 161).*\]
25-
- **Get community string:** \[*The community string used when reading values from the device (default value is not overridden in the connector: public).*\]
26-
- **Set community string:** \[*The community string used when setting values on the device (*default value is not overridden in the connector: private*).*\]
25+
- **IP address/host**: The polling IP of the device.
2726

28-
## Usage
27+
SNMP Settings:
2928

30-
In this section of the connector help, some general info is available about the usage of the Memotec NetPerformer connector.
29+
- **IP port**: The IP port of the device.
30+
- **Get community string**: The community string used when reading values from the device (default: *public*).
31+
- **Set community string**: The community string used when setting values on the device (default: *private*).
32+
33+
## Usage
3134

3235
### Main Menu
3336

@@ -38,16 +41,16 @@ In this section of the connector help, some general info is available about the
3841

3942
All the global parameters available for configuration are shown here. Also, the following pages are provided with extra settings:
4043

41-
- **Extra ...**
42-
- **Rackmount Chassis ...**
44+
- **Extra**
45+
- **Rackmount Chassis**
4346

4447
### Configuration - Advanced
4548

46-
All parameters which are redundancy related are available on the following pages:
49+
All redundancy-related parameters are available on the following pages:
4750

48-
- **Redundancy Criteria ...**
49-
- **Redundancy Remote ...**
50-
- **Redundancy Switch ...**
51+
- **Redundancy Criteria**
52+
- **Redundancy Remote**
53+
- **Redundancy Switch**
5154

5255
### Configuration - Others
5356

@@ -57,17 +60,17 @@ This page provides an overview of some general configurations of the NetPerforme
5760

5861
This page provides access to all the different configuration profiles available on the NetPerformer unit for **IP configuration**:
5962

60-
- **BOOTP ...**
61-
- **DNS ...**
63+
- **BOOTP**
64+
- **DNS**
6265
- **Global IP...**
63-
- **NAT ...**
64-
- **OSPF ...**
65-
- **RADIUS ...**
66-
- **SNMP ...**
67-
- **Source-Static ...**
68-
- **Static ...**
69-
- **TimeP ...**
70-
- **Interfaces ...**
66+
- **NAT**
67+
- **OSPF**
68+
- **RADIUS**
69+
- **SNMP**
70+
- **Source-Static**
71+
- **Static**
72+
- **TimeP**
73+
- **Interfaces**
7174

7275
### Configuration - Slots Link
7376

@@ -103,18 +106,18 @@ The **Errors** page lets you have access to various types of errors.
103106

104107
This page provides an overview of all various types of states:
105108

106-
- **States Redundancy ...**
107-
- **States Voice ...**
108-
- **States LDC ...**
109-
- **States System ...**
110-
- **States Port Eth ...**
111-
- **States Port CSL ...**
112-
- **States Port 1-304 ...**
109+
- **States Redundancy**
110+
- **States Voice**
111+
- **States LDC**
112+
- **States System**
113+
- **States Port Eth**
114+
- **States Port CSL**
115+
- **States Port 1-304**
113116

114117
### Routing Table
115118

116119
The NetPerformer Routing provides access to various **Routing Table** selections.
117120

118121
### Web Interface
119122

120-
Use this page to have access to the **Web Interface** provided by the device's web server. Only in a LAN environment it's possible to have access to this page.
123+
Use this page to have access to the **Web Interface** provided by the device's web server. The web interface is only accessible when the client machine has network access to the product.

connector_help/connector-help/CEFD_Memotec_Netperformer_SDM8400.md

+36-34
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,27 @@ The Memotec Netperformer SDM8400 version is an SNMP connector intended to commun
88

99
## About
1010

11-
A SNMP connection is used in order to successfully retrieve and configure the device's information.
11+
An SNMP connection is used in order to successfully retrieve and configure the device's information.
1212

13-
## Installation and configuration
13+
## Configuration
1414

15-
### Creation
15+
### Connections
1616

17-
**SNMP Connection:**
17+
#### SNMP Connection - Main
1818

19-
- **IP Address/host:** \[*The polling IP of the device.*\]
19+
This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
2020

21-
**SNMP Settings:**
21+
SNMP CONNECTION:
2222

23-
- **Port Number:** \[*The port of the connection device (default: 161).*\]
24-
- **Get community string:** \[*The community string used when reading values from the device (default value is not overridden in the connector: public).*\]
25-
- **Set community string:** \[*The community string used when setting values on the device (*default value is not overridden in the connector: public*).*\]
23+
- **IP address/host**: The polling IP of the device.
2624

27-
## Usage
25+
SNMP Settings:
2826

29-
In this section of the connector help, some general info is available about the usage of the Memotec Netperformer connector.
27+
- **IP port**: The IP port of the device.
28+
- **Get community string**: The community string used when reading values from the device (default: *public*).
29+
- **Set community string**: The community string used when setting values on the device (default: *public*).
30+
31+
## How to Use
3032

3133
### Main Menu
3234

@@ -36,16 +38,16 @@ Here is some general info about the unit.
3638

3739
All the global parameters available for configuration are shown here. Also, the following pages are provided with extra settings:
3840

39-
- **Extra...**
40-
- **Rackmount Chassis...**
41+
- **Extra**
42+
- **Rackmount Chassis**
4143

4244
### Configuration - Advanced
4345

44-
All parameters which are redundancy related are available on the following pages:
46+
All redundancy-related parameters are available on the following subpages:
4547

46-
- **Redundancy Criteria...**
47-
- **Redundancy Remote...**
48-
- **Redundancy Switch...**
48+
- **Redundancy Criteria**
49+
- **Redundancy Remote**
50+
- **Redundancy Switch**
4951

5052
### Configuration - Others
5153

@@ -55,17 +57,17 @@ This page provides an overview of some general configurations of the Netperforme
5557

5658
This page provides access to all the different configuration profiles available on the Netperformer unit for **IP Configuration**:
5759

58-
- **BOOTP...**
59-
- **DNS...**
60-
- **Global IP...**
61-
- **NAT...**
62-
- **OSPF...**
63-
- **RADIUS...**
64-
- **SNMP...**
65-
- **Source-Static...**
66-
- **Static...**
67-
- **TimeP...**
68-
- **Interfaces...**
60+
- **BOOTP**
61+
- **DNS**
62+
- **Global IP**
63+
- **NAT**
64+
- **OSPF**
65+
- **RADIUS**
66+
- **SNMP**
67+
- **Source-Static**
68+
- **Static**
69+
- **TimeP**
70+
- **Interfaces**
6971

7072
### Configuration - Slots Link
7173

@@ -101,16 +103,16 @@ The **Errors** page lets you have access to various types of errors.
101103

102104
This page provides an overview of all various types of states:
103105

104-
- **States LDC...**
105-
- **States Redundancy...**
106-
- **States Port Eth...**
107-
- **States Port CSL...**
108-
- **States Port 1-304...**
106+
- **States LDC**
107+
- **States Redundancy**
108+
- **States Port Eth**
109+
- **States Port CSL**
110+
- **States Port 1-304**
109111

110112
### Routing Table
111113

112114
The Netperformer Routing provides access to various Routing Table selections.
113115

114116
### Web Interface
115117

116-
Use this page to have access to the **Web Interface** provided by the device's web server. Only in a LAN environment it is possible to have access to this page.
118+
Use this page to have access to the **Web Interface** provided by the device's web server. The web interface is only accessible when the client machine has network access to the product.

connector_help/connector-help/Castlerock_SNMPc_-_Node.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This connector displays detailed information regarding a device connected to the
1010

1111
This connector is used for **the created DVEs** corresponding to specific nodes in the **Node Table** on the **Device page** of the parent connector **Castlerock SNMPc**.
1212

13-
Note that a DVE is only created if a specific cell is toggled and the DVE can also be removed again in a similar manner. Refer to the connector help of the parent connector for more information.
13+
Note that a DVE is only created if a specific cell is toggled and the DVE can also be removed again in a similar manner. For more information, see [Castlerock SNMPc](xref:Connector_help_Castlerock_SNMPc).
1414

1515
This connector is automatically generated by the connector Castlerock SNMPc, range 1.0.1.x.
1616

@@ -24,7 +24,7 @@ This connector is automatically generated by the connector Castlerock SNMPc, ran
2424

2525
### Creation
2626

27-
DVEs running this connector can only be created via the parent connector. More details on how to set up a connection with the device can be found on the connector help page of the parent connector.
27+
DVEs running this connector can only be created via the parent connector. For more details on how to set up a connection with the device, see [Castlerock SNMPc](xref:Connector_help_Castlerock_SNMPc).
2828

2929
## Usage
3030

0 commit comments

Comments
 (0)