Initial Overview and Deployment sections

Author: GelberMSkyline

.gitignore

@@ -7,3 +7,4 @@
 /**/bin/
 /**/obj/
 _site
+.idea

README.md

@@ -8,9 +8,6 @@ This repository serves as the central hub when we want to work together with our
 
 Navigate to our documentation: [Home Page](index.md)
 
-> [!IMPORTANT]
-> Please read carefully the guidelines outlined in the [Getting Started](xref:gettingStarted)
-
 ## Why Documentation Matters
 
 Documentation provides a shared understanding and knowledge base for our team and our customers. It serves as a reference point, enabling us to:
@@ -24,10 +21,9 @@ Documentation provides a shared understanding and knowledge base for our team an
 We encourage all team members to actively contribute to our documentation efforts.
 
 > [!NOTE]
-> Of course, it should be clear that we are doing this effort as part of our deliverables, and hence it should be clear this is categorized as **engineering work (billable)**.
-
-Want to contribute? Check out [Contributing to the project documentation](xref:contributing)
+> Every new project **must have** basic documentation provided, and it is imperative that sales account for the effort required during the offering phase.
 
+Want to contribute? 
  Here's how you can get involved:
 
 1. **Collaborate with Customers:** Engage with our users to gather insights and feedback. Their input is invaluable in creating user-friendly documentation.
@@ -42,17 +38,17 @@ Want to contribute? Check out [Contributing to the project documentation](xref:c
 > For Skyline employees: Please include a link from [InternalDocs - ProjectDocs](https://internaldocs.skyline.be/Projects/Projects.html) to this repository
 
 1. Follow the steps described at [Creating a repository from a template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template)
-1. While creating the new repository, take into account the [GitHub Repository Guidelines](https://docs.dataminer.services/develop/CICD/Skyline%20Communications/Github/Use_Github_Guidelines.html) described in the DataMiner Docs. 
+2. While creating the new repository, take into account the [GitHub Repository Guidelines](https://docs.dataminer.services/develop/CICD/Skyline%20Communications/Github/Use_Github_Guidelines.html) described in the DataMiner Docs. 
     1. Suggested Naming Convention: {customerAcronym}-DOC-NameOfProject
     2. Add/Change the license according to what is agreed with the customer
     3. Add GitHub repository topics: dataminer-doc
-1. Once the repository is cloned, add your custom documentation available in the 'articles' folder. Suggest structure:
+3. Once the repository is cloned, add your custom documentation available in the 'articles' folder. Suggest structure:
     1. overview.md: the purpose of the environment is documented with a high-level overview of the most important components
     2. features.md: key components of the environment, typically with subfolders
     3. infrastructure.md: user-oriented POV explanation of how the environment is built (architecture, database types, failover, etc.)
-1. You can build a test build by following [Contributing to the project documentation](xref:contributing).
-1. When you are happy with your changes, push them to the GitHub repository.
-1. GitHub actions will make an artifact available that you put on your DataMiner which will host this as a static website. If you are interested, follow the steps in the section below.
+4. You can build a test build by following Contributing to the project documentation
+5. When you are happy with your changes, push them to the GitHub repository.
+6. GitHub actions will make an artifact available that you put on your DataMiner which will host this as a static website. If you are interested, follow the steps in the section below.
 
 ### Tips
 
@@ -73,7 +69,7 @@ Our documentation artifacts are generated automatically through GitHub Actions.
 1. Configure the default file in ISS
     1. Go to Internet Information Services (IIS) Manager
     1. Find the 'Documentation' folder you have added
-    1. In the 'IIS' section, double click on 'Default Document'
+    1. In the 'IIS' section, double-click on 'Default Document'
     1. Include the index.html on the list.
 1. Navigate to 'https://`hostname`/Documentation' to view the website
 

articles/Deployment/deployment.md

@@ -0,0 +1,18 @@
+---
+uid: deployment_deployment
+---
+
+### High-Level Design Overview
+<!-- REMOVABLE DESCRIPTION
+We have been using two forms to provide a high-level overview of the solution's deployment. Most commonly, we include a
+textual description of the system's components and a package diagram that contains a brief summary of each component.
+-->
+#### Textual description
+
+The {{PROJECT_NAME}} project comprises three independent DMS clusters, each configured as detailed below and offering
+specific features outlined in [value delivery](xref:overview_overview).
+
+#### Alpha Cluster
+Alpha cluster has multiple agents covering London, Brussels, and Washington DC locations. It provides standard monitoring
+and control functionality listed in the [delivery features](xref:overview_overview#delivered-value) section.
+

articles/Features/feature_1.md

@@ -0,0 +1,28 @@
+---
+uid: overview_access
+---
+
+# Access Overview
+<!-- REMOVABLE DESCRIPTION
+Depending on the project, use a short description of the form the system is accessible, potentially by splitting the
+description in case there are multiple DMSs. Below some examples of the typical access methods. Please select and combine
+ -->
+> ### Attention 🚨
+> Access credentials should be stored in the [Skyline Password Manager](https://passwords.skyline.be/).
+
+> ### Access through the squad members
+> Credentials are assigned per person and will be applicable for every DMS system in {{PROJECT_NAME}}. {{PROJECT_NAME}}
+> systems are cloud-connected and remote access is allowed to the {{DEPLOY_SQUAD}} squad and some members of the support
+> team. Please, reach out to [{{DEPLOY_SQUAD}}](mailto:{{EMAIL_SQUAD}}) squad in case you need remote access to {{PROJECT_NAME}} systems.
+>
+
+> ### Access via VPN client and credentials
+> * Open a web browser and navigate to the {{CUSTOMER}} [VPN Portal](https://{{CUSTOMER_VPN_PORTAL}}).
+> * Login using the valid VPN credentials available on [Skyline Password Manager](https://passwords.skyline.be/).
+> * Select one of the user that can authenticate your connection using the {{2FA_AUTHENTICATOR}} and select the preferable 
+> authentication method(send me a push or enter a password).
+> * After successful authentication it should start downloading {{VPN_CLIENT}} and install it in your PC, if you don't have it yet.
+> * The {{VPN_CLIENT}} should now indicate that you are connected as following:
+> ![pulse_vpn_client.png](../../images/pulse_vpn_client.png)
+> * After successful VPN connection, RDP to jump servers and then from jump servers you can RDP to any server either under
+>   {{DMS_CLUSTER_NAME}}cluster.

articles/Features/feature_2.md

@@ -0,0 +1,23 @@
+---
+uid: overview_overview
+---
+# About {{PROJECT_NAME}}
+
+## Value proposition
+A value proposition should clearly articulate the benefits and solutions the project brings to its users or stakeholders.
+It should emphasize how the delivered system addresses specific challenges, such as improving workflow efficiency, 
+enhancing content delivery, ensuring reliability, or enabling the implementation of novel services.
+
+The value proposition should highlight innovative features like automation, integration with existing
+broadcasting tools, or scalability to meet industry demands. It's important to communicate measurable outcomes,
+such as time savings, cost reductions, or quality improvements directly impacting broadcasting professionals and their operations.
+
+## Delivered value
+There are multiple forms to express the delivered value, following some forms:
+
+* **Detailed value description:** A brief paragraph describing how the solution solves the user's needs or problems.
+* **Bulleted list of key benefits:** A quick and easy-to-read list of the project's features or advantages.
+* **Infographics:** Graphical representations, such as charts, models, or workflows, to list the features or advantages.
+* **Comparative Improvements:** A list of the achieved improvements of any defined KPIs
+* **Customer phrases or outcomes:** Testimonials, use cases, or scenarios describing the success stories and how potential users can benefit
+

articles/GettingStarted/contributing.md

@@ -0,0 +1,24 @@
+---
+uid: overview_references
+---
+
+## Internal documentation
+During the deployment phase, we developed comprehensive documentation that captures the insights gained from discussions
+with the sales team and later with the customer during the various stages of the project delivery.
+
+All of these valuable documents are accessible in our internal project folder. The most pertinent information can be found
+in the following folders:
+
+| Folder                                                                                  | Content                                                                             |
+|-----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
+| [10-Requirements](https://skylinebe.sharepoint.com/:f:/s/ProjectData/{{PROJECT_DATA}})  | Contains different technical documents for the definition of connectors, LCAs, etc. |
+| [15.3-SOW](https://skylinebe.sharepoint.com/:f:/s/ProjectData/{{PROJECT_DATA}})         | All the versions of the Statement of Work that were discussed with the customer.    |
+| [30-Planning](https://skylinebe.sharepoint.com/:f:/s/ProjectData/{{PROJECT_DATA}})      | The discussed value delivery plan.                                                  |
+
+
+## External documentation
+Provide a list of relevant external documentation for system understanding and troubleshooting. This should include resources
+like user manuals, API documentation, or configuration procedures.
+* [What is SignalR?](https://learn.microsoft.com/en-us/aspnet/core/signalr/introduction?view=aspnetcore-9.0&WT.mc_id=dotnet-35129-website)
+* [What is OpenTelemetry?](https://opentelemetry.io/docs/what-is-opentelemetry/)
+* [What is NATs](https://docs.nats.io/nats-concepts/what-is-nats)

articles/GettingStarted/gettingStarted.md

@@ -1,19 +1,10 @@
 items:
 - name: Overview
-  topicUid: overview
-- name: Features
-  topicUid: features
+  topicUid: overview_overview
   items:
-  - name: Feature 1
-    topicUid: feature1
-  - name: Feature 2
-    topicUid: feature2
-- name: Infrastructure
-  topicUid: infrastructure
-- name: Getting started
-  topicUid: gettingStarted
-  items:
-  - name: Markdown
-    topicUid: markdown
-  - name: Contributing
-    topicUid: contributing
+      - name: Access
+        topicUid: overview_access
+      - name: References
+        topicUid: overview_references
+- name: Deployment
+  topicUid: deployment_deployment

articles/GettingStarted/markdown.md

@@ -1,4 +1,4 @@
-{
+  {
   "build": {
     "content": [
       {

articles/Overview/access.md

@@ -8,6 +8,5 @@ Welcome to the project documentation template.
 
 ## Overview
 
-- [Overview](xref:overview)
-- [Features](xref:features)
-- [Infrastructure](xref:infrastructure)
+- [Overview](xref:overview_overview)
+- [Deployment](xref:deployment_deployment)