Merge branch 'SkylineCommunications:main' into Partner-Program

Author: EdithLansens

.github/workflows/azure-static-web-apps-victorious-sea-0e7978f03.yml

@@ -22,6 +22,8 @@ jobs:
           choco install docfx -y
         env:
           CI: true
+      - name: Restore NuGet
+        run: nuget restore "src/Base Class Library"
       - name: build metadata
         run: |
           docfx metadata -f

CONTRIBUTING.md

@@ -99,6 +99,9 @@ For larger contributions, e.g. to add several new pages, we recommend that you i
 
 - [Visual Studio Code](https://code.visualstudio.com/) (with the [Learn Authoring Pack](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-authoring-pack) extension)
 
+> [!NOTE]
+> Microsoft also provides a zero-install Visual Studio Code for the web. When you are working in GitHub online, you can access this by pressing the "." button on your keyboard. This version offers a complete overview of the repository like in the downloadable version of Visual Studio Code, but it does not offer any extensions, e.g. a spell check.
+
 When you install GitHub Desktop, you will also need to add the correct repository:
 
 1. Install GitHub Desktop and log in with your GitHub account.
@@ -138,7 +141,7 @@ When you install GitHub Desktop, you will also need to add the correct repositor
 
 For more information on how to work with Visual Studio Code, refer to the [Visual Studio Code documentation](https://code.visualstudio.com/docs). As our documentation is written in Markdown, aside from the general functionality of the application, the [Markdown](https://code.visualstudio.com/docs/languages/markdown) section is of specific interest there.
 
-Also keep in mind that we are using **DocFX Flavored Markdown**. Refer to the [Markdown syntax](#markdown-syntax) section above for more information about this. Make sure the Learn Authoring Pack extension is installed in Visual Studio Code to make it easier to work with this Markdown flavor.
+Also keep in mind that we are using **DocFX Flavored Markdown**. Refer to the [Markdown syntax](#markdown-syntax) section below for more information about this. Make sure the Learn Authoring Pack extension is installed in Visual Studio Code to make it easier to work with this Markdown flavor.
 
 ### Things to watch out for
 
@@ -342,7 +345,9 @@ To be able to make a local test build, you need to have DocFX installed. DocFX i
    1. Enter `docfx metadata -f` to generate the metadata.
 
       > [!NOTE]
-      > At this point, you may get 5 warnings mentioning "Found project reference without a matching metadata reference". These can be ignored.
+      >
+      > - At this point, you may get 5 warnings mentioning "Found project reference without a matching metadata reference". These can be ignored.
+      > - At this point, if you get up to 13 warnings, of which 8 mention "Invalid cref value", follow the steps explained [here](#running-docfx-metadata--f-results-in-warnings-mentioning-an-invalid-cref-value).
 
    1. Enter `docfx build -f` to make a test build.
 
@@ -512,6 +517,17 @@ You can align the pipe characters so that the table also looks like a table in t
 
 If table cells contain a lot of text, it can be next to impossible to keep everything neatly aligned in the Markdown source, so in that case this second syntax may be preferable. Just make sure you use the correct number of pipe characters so that your number of columns is the same in each row, otherwise the table will not be generated correctly.
 
+Also note that you can align table columns by using colons. See the following example:
+
+```md
+| Fun                  | With                 | Tables          |
+| :------------------- | -------------------: |:---------------:|
+| left-aligned column  | right-aligned column | centered column |
+| $100                 | $100                 | $100            |
+| $10                  | $10                  | $10             |
+| $1                   | $1                   | $1              |
+```
+
 ### Code blocks
 
 To display code examples in separate code blocks, place three backquotes (```) above and below those blocks. In addition, next to the three backquotes above the blocks, specify the type of code, e.g. *csharp*, *md*, *xml*, etc.
@@ -664,6 +680,103 @@ Be careful when you use screenshots of the DataMiner Cube UI, as these can get o
 
 If you do add a screenshot, ideally there should be some indication of the version of the software displayed in the screenshot, so it is clear if the screenshot is outdated.
 
+## Address the reader directly
+
+Avoid writing about your reader as "the user", but instead use "you".
+
+The only time when "the user" is appropriate is when whoever you are writing for will create or configure something for another user, and it is that other user you want to indicate.
+
+**Examples:**
+
+- *You can find more information on DataMiner Dojo.* (Instead of *The user can find more information on DataMiner Dojo.*)
+
+- *When you add a feed component to a dashboard, the user of the dashboard will be able to select a feed.*
+
+## Troubleshooting
+
+### There is a duplicate item in the TOC even though it only occurs once in the toc.yml
+
+**Symptom**: An item shows up twice in the table of contents even though it was only entered once in the *toc.yml*.
+
+**Resolution**: Make sure there is no hyphen in front of the topicUID line. Only the name line should be preceded by a hyphen.
+
+![TOC](~/images/TOC.png)
+
+### Build failed because assembly or file could not be loaded
+
+**Symptom**: When you try to create a test build, this fails with the following error:
+
+```txt
+   Build failed.
+   [22-11-04 12:34:56.248]Warning:[ImportPlugins]Skipping file D:\DocFX\plugins_2xobfivj.yks\plugins\System.Memory.dll due to load failure: Could 
+   not load file or assembly 'System.Memory, Version=4.0.1.2, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51' or one of its dependencies. 
+   The located assembly's manifest definition does not match the assembly reference.
+   (Exception from HRESULT: 0x80131040)
+```
+
+**Resolution**: Install [the latest version of DocFX](#installing-and-configuring-docfx).
+
+### Build failed because config or content files are missing
+
+**Symptom**: When you try to create a test build, this fails with the following error:
+
+```txt
+   Build failed.
+   [22-11-04 12:34:56.248]Error:Either provide config file or specify content files to start building documentation.
+           O Warning(s)
+           1 Error(s)
+```
+
+**Resolution**: This issue occurs if you try to make a build of only part of the repository. There are specific files in the root of the repository that are needed to be able to start building documentation, so make sure you always create your test builds based on the complete repository.
+
+### Recent changes do not show up in a build
+
+**Symptom**: When you create a test build, it does not include your recent changes.
+
+**Resolution**: Make sure your changes are all saved. If the *Explorer* icon in the top-left corner shows a blue circle with a number in it, there are unsaved changes in a number of files corresponding with that number. The files that contain unsaved changes are marked with a white dot in the file header.
+
+![Unsaved changes](~/images/Unsaved_Changes.png)
+
+### GitHub Desktop keeps basing branches on an outdated version of ‘main’
+
+**Symptom**: Newly created branches indicate that they were created a longer time ago.
+
+**Resolution**:
+
+- Make sure [your fork is up to date](#make-sure-your-fork-is-up-to-date).
+
+- If you installed Git after you installed GitHub Desktop, remove the repository in GitHub Desktop and add it again.
+
+### Running 'docfx metadata -f' results in warnings mentioning an invalid cref value
+
+**Symptom**: When you enter `docfx metadata -f` in the Terminal pane in Visual Studio Code, you get several warnings that look like this:
+
+```txt
+[22-12-14 07:59:45.600]Warning:[ExtractMetadata]Invalid cref value "!:JsonReaderException" found in triple-slash-comments for FromJsonString defined in src/Base Class Library/Common/Skyline/DataMiner/Library/Common/Rates/RateHelper.cs Line 309, ignored.
+[22-12-14 07:59:45.600]Warning:[ExtractMetadata]Invalid cref value "!:JsonReaderException" found in triple-slash-comments for FromJsonString defined in src/Base Class Library/Common/Skyline/DataMiner/Library/Common/Rates/RateHelper.cs Line 354, ignored.
+```
+
+**Resolution**:
+
+1. Open Visual Studio.
+
+1. Select to open a project or solution and open *C:\...\GitHub\dataminer-docs\src\Base Class Library\Code Library.sln*.
+
+1. In the *Solution Explorer* pane, right-click *Solution 'Code Library'* and select *Restore NuGet packages*.
+
+   You will get the following output:
+
+   ```txt
+   `Restored C:\...\GitHub\dataminer-docs\src\Base Class Library\Common\Common.csproj (in 340 ms).
+   NuGet package restore finished
+   Time Elapsed: 00:00:00.7119526
+   ========== Finished ==========
+   ```
+
+1. Enter `docfx metadata -f` in Visual Studio Code again.
+
+   You should now get no more than 5 warnings when generating the metadata.
+
 ## References
 
 As our way of working is very similar to the approach used for Microsoft Docs, it can be useful to take a look at the [Microsoft Docs Contributor Guide](https://docs.microsoft.com/en-us/contribute/) for additional information and guidelines.

README.md

@@ -1,3 +1,5 @@
+![CI/CD](https://github.com/SkylineCommunications/dataminer-docs/actions/workflows/azure-static-web-apps-victorious-sea-0e7978f03.yml/badge.svg)
+
 # dataminer-docs
 
 Open-source documentation of DataMiner.

connectors/images/2022-07-05 15_26_05-Clipboard.png

@@ -0,0 +1,32 @@
+---
+uid: FAQ_DCP
+---
+
+# Questions related to DataMiner Cloud Services
+
+### How is security handled by the Cloud Platform Services?
+
+See [Cloud connectivity and security](xref:Cloud_connectivity_and_security).
+
+### How do I connect a DMS to the cloud? What are the prerequisites?
+
+See [Connecting your DataMiner System to the cloud](xref:Connecting_your_DataMiner_System_to_the_cloud).
+
+### Do all Agents in a DMS have to be connected to the cloud?
+
+No, this is only required for a single Agent within a private DataMiner System. However, there are a couple of advantages to connecting more than one Agent:
+
+- **Redundancy**: The Cloud Gateway nodes run independently from each other. Each one of them will maintain a tunnel connection to the DataMiner Cloud Platform. This means that when the connection is lost for one DMA, you will still be cloud-connected through the other Cloud Gateway nodes.
+
+- **Load balancing**: Every time you open a shared dashboard or relay to your DMS, a random Cloud Gateway node is chosen to process your session. This means that the opening of multiple shares is distributed over the various Cloud Gateways. As a Cloud Gateway always forwards the traffic to the same web API service, this also distributes the load across different web API services in the cluster.
+
+> [!NOTE]
+> At this time, we recommend running 1 to 3 Cloud Gateway nodes in a cluster. Running more Cloud Gateway nodes than that in a cluster would only add an unnecessary extra load on the DataMiner Cloud Platform.
+
+### How does the live sharing work, and how is it secured?
+
+Users can share a dashboard by clicking *Share* or *Start sharing* at the top of the dashboard. For more details, see [Sharing a dashboard](xref:Sharing_a_dashboard).
+
+The sharing recipients will receive a link via email on the email address specified by the share creator. When they open the link, the recipients will be asked to authenticate as the rightful owner of the email address by logging in to an account from the DataMiner Cloud Platform, Microsoft, Google, LinkedIn, or Amazon linked to that email address, or by creating a dedicated DataMiner Cloud Platform account if they do not have any of the formerly mentioned accounts. After successfully authenticating, the recipient will be directed to the dashboard through the DataMiner Cloud Platform tunnel.
+
+No data from the private DataMiner System hosting the dashboard is stored on the DataMiner Cloud Platform. The share can be deleted in the same way as it was created. All emailed links will then automatically become unreachable.

connectors/images/Evertz_3080IPX_general.png

@@ -2,7 +2,7 @@
 uid: FAQs_Pricing
 ---
 
-# Questions related to pricing of usage-based services
+# Questions related to commercial models
 
 - **Can different commercial models exist in the same organization?**
 

dataminer-overview/FAQ/FAQ_DCP.md

@@ -13,6 +13,7 @@ We are working on adding more information to this section soon, so check back fo
 - [DataMiner Cloud Platform](xref:Overview_DCP)
 - [Agile partnership](xref:Overview_Agile_Partnership_intro)
 - [Training courses and certification](xref:Overview_Training_intro)
+- [Pricing](xref:Pricing)
 - [Support Services](xref:Overview_Support_DMS_M_and_S)
 - [Compliance statements](xref:Overview_Compliance_Statements_intro)
 - [Partner Program](xref:Partner_Program)

dataminer-overview/FAQ/FAQs_Pricing.md

@@ -6,36 +6,9 @@ uid: Pricing
 
 DataMiner open monitoring and orchestration software is a transformational platform offering a broad range of modular functions with an unlimited number of applications. Depending on where you find yourself on your digital transformation journey, on what your business models and strategy are, and on how you intend to use the platform, you may be looking for different commercial and delivery models. Skyline can offer you maximum choice and flexibility to perfectly align with your priorities.
 
-DataMiner can be used with **Perpetual-Use Licenses** or with two flavors of usage-based service models, namely the **Subscription Plan** and the **Pay-per-Use Plan**.
-
-For the usage-based models, pricing is available for both self-hosted (on-premises or in a private cloud) and Skyline-hosted (referred to as *DataMiner as a Service*) systems.
+- [Commercial models summary](xref:Pricing_Commercial_Models)
+- [Usage-based services](xref:Pricing_Usage_based_service)
+- [Perpetual-Use Licensing](xref:Pricing_Perpetual_Use_Licensing)
 
 > [!TIP]
 > See also: [Questions related to pricing of usage-based services](xref:FAQs_Pricing)
-
-## Perpetual-Use Licenses
-
-Perpetual-Use Licensing is based on the proven and flexible DataMiner Licensing Scheme, which has been available for several years. Licenses are available for **DataMiner nodes** (which are available in different capacity tiers to manage a set number of Managed Objects), for **optional features**, and for **connectors** that interface DataMiner with different third-party products (the latter irrespective of the total number of elements managed with the connector, and with a fixed price regardless of whether the connector exists or still needs to be developed).
-
-Perpetual-Use Licenses are a one-off expenditure.
-
-> [!NOTE]
-> Perpetual-Use License deployments are typically further complemented by the optional [DataMiner Support Services](xref:Overview_Support_DMS_M_and_S), which provide both technical support as well as unlimited access to all available DataMiner software upgrades and updates. For Perpetual-Use Licenses, the cost for DataMiner Support Services is an annual recurring fee, relative to the value of the deployed Perpetual-Use Licenses.
-
-> [!TIP]
-> See also: [DataMiner Perpetual-Use Licenses vs Usage-based services](xref:Pricing_PerpetualUseLicenses_vs_UsageBasedServices)
-
-## Usage-based services
-
-> [!TIP]
-> See also: [Usage-based services](xref:Pricing_Usage_based_service)
-
-### Subscription Plan
-
-DataMiner Subscription Plan is a yearly subscription built around a flexible, simple and transparent software utilization offering whereby a **Monthly Utilization Allowance (MUA)** is available for the operational teams to leverage DataMiner and to evolve it easily and continuously as dictated by their momentary needs, in terms of scale, in terms of utilization of its wealth of modular functions, and in terms of interfacing with third-party products.
-
-The Subscription Plan offering results in a well-defined and controlled expenditure, combined with maximum freedom for the operational teams to leverage any of the many capabilities of DataMiner without any limitation, in any way deemed of value for the operation.
-
-### Pay-per-Use
-
-DataMiner Pay-per-Use is the most flexible model, very similar to the Subscription Service, but with no fixed Monthly Utilization Allowance nor annual contract or commitments. DataMiner usage is simply metered on a monthly basis and deducted from the defined allowance.