Skip to content

Commit ea3ab4c

Browse files
GelberMSkylineGelberMSkyline
committed
New layout
1 parent 2c5b30c commit ea3ab4c

11 files changed

+114
-113
lines changed

‎articles/Deployment/deployment.md ‎Projects/PRJNAME/Deployment/deployment.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
---
2-
uid: <PRJID>_deployment_deployment
3-
---
4-
5-
# High-Level Design Overview
6-
<!-- REMOVABLE DESCRIPTION
7-
We have been using two forms to provide a high-level overview of the solution's deployment. Most commonly, we include a
8-
textual description of the system's components and a package diagram that contains a brief summary of each component.
9-
-->
10-
## Textual description
11-
12-
The {{PROJECT_NAME}} project comprises three independent DMS clusters, each configured as detailed below and offering
13-
specific features outlined in [value delivery](xref:<PRJID>_overview_overview).
14-
15-
## Alpha Cluster
16-
Alpha cluster has multiple agents covering London, Brussels, and Washington DC locations. It provides standard monitoring
17-
and control functionality listed in the [delivery features](xref:<PRJID>_overview_overview#delivered-value) section.
18-
1+
---
2+
uid: <PRJID>_deployment_deployment
3+
---
4+
5+
# High-Level Design Overview
6+
<!-- REMOVABLE DESCRIPTION
7+
We have been using two forms to provide a high-level overview of the solution's deployment. Most commonly, we include a
8+
textual description of the system's components and a package diagram that contains a brief summary of each component.
9+
-->
10+
## Textual description
11+
12+
The {{PROJECT_NAME}} project comprises three independent DMS clusters, each configured as detailed below and offering
13+
specific features outlined in [value delivery](xref:<PRJID>_overview_overview).
14+
15+
## Alpha Cluster
16+
Alpha cluster has multiple agents covering London, Brussels, and Washington DC locations. It provides standard monitoring
17+
and control functionality listed in the [delivery features](xref:<PRJID>_overview_overview#delivered-value) section.
18+

‎articles/Deployment/high_level_architecture.md ‎Projects/PRJNAME/Deployment/high_level_architecture.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
---
2-
uid: <PRJID>_deployment_high_level_architecture
3-
---
4-
5-
# High Level Architecture
6-
7-
<!-- REMOVABLE DESCRIPTION
8-
A high-level architecture outlines the interconnected components and how they interact to deliver a cohesive solution. It can be organized around elements (hardware or software) providing functionality to form the services utilized by end users.
9-
-->
10-
## Components
11-
As shown in the diagram below, the SOLUTION consists of three different hardware elements, including two DataMiner systems that contain the necessary modules for processing and distributing messages:
12-
13-
![components.png](../../images/components.png)
14-
15-
## Interactions
16-
17-
In the interaction diagram below, a DataMiner node process query commands from an aggregator in response to external actions from an implemented third-party application UI:
18-
![interactions.png](../../images/interactions.png)
1+
---
2+
uid: <PRJID>_deployment_high_level_architecture
3+
---
4+
5+
# High Level Architecture
6+
7+
<!-- REMOVABLE DESCRIPTION
8+
A high-level architecture outlines the interconnected components and how they interact to deliver a cohesive solution. It can be organized around elements (hardware or software) providing functionality to form the services utilized by end users.
9+
-->
10+
## Components
11+
As shown in the diagram below, the SOLUTION consists of three different hardware elements, including two DataMiner systems that contain the necessary modules for processing and distributing messages:
12+
13+
![components.png](../../../images/_PRJNAME_/components.png)
14+
15+
## Interactions
16+
17+
In the interaction diagram below, a DataMiner node process query commands from an aggregator in response to external actions from an implemented third-party application UI:
18+
![interactions.png](../../../images/_PRJNAME_/interactions.png)

‎articles/Deployment/infrastructure.md ‎Projects/PRJNAME/Deployment/infrastructure.md

+30-30
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
1-
---
2-
uid: <PRJID>_deployment_infrastructure
3-
---
4-
5-
# DataMiner Infrastructure
6-
7-
The infrastructure for {{PROJECT_NAME}} is built around a single Dataminer cluster, comprising X DMAs.
8-
9-
| ID | DMA Name | Location | Host | IP |
10-
|------------|-----------------|-------------------------|-----------------|----------------|
11-
| {{DMA_ID}} | {{DMA_NAME}} | {{DMA_LOCATION}} | {{DMA_HOST}} | {{DMA_IP}} |
12-
| {{DMA_ID}} | {{DMA_NAME}} | {{DMA_LOCATION}} | {{DMA_HOST}} | {{DMA_IP}} |
13-
| {{DMA_ID}} | {{DMA_NAME}} | {{DMA_LOCATION}} | {{DMA_HOST}} | {{DMA_IP}} |
14-
15-
# Storage Infrastructure
16-
17-
<!-- REMOVABLE DESCRIPTION
18-
We can either describe the storage cluster's location and reference other documentation, or we can create a table that illustrates the general information of the nodes.
19-
-->
20-
### Cassandra Nodes
21-
| Server Name | IP Address |
22-
|--------------------|------------------|
23-
| {{CASSANDRA_NAME}} | {{CASSANDRA_IP}} |
24-
| {{CASSANDRA_NAME}} | {{CASSANDRA_IP}} |
25-
26-
### Opensearch Nodes
27-
28-
| Server Name | IP Address |
29-
|----------------|--------------|
30-
| {{OPENS_NAME}} | {{OPENS_IP}} |
1+
---
2+
uid: <PRJID>_deployment_infrastructure
3+
---
4+
5+
# DataMiner Infrastructure
6+
7+
The infrastructure for {{PROJECT_NAME}} is built around a single Dataminer cluster, comprising X DMAs.
8+
9+
| ID | DMA Name | Location | Host | IP |
10+
|------------|-----------------|-------------------------|-----------------|----------------|
11+
| {{DMA_ID}} | {{DMA_NAME}} | {{DMA_LOCATION}} | {{DMA_HOST}} | {{DMA_IP}} |
12+
| {{DMA_ID}} | {{DMA_NAME}} | {{DMA_LOCATION}} | {{DMA_HOST}} | {{DMA_IP}} |
13+
| {{DMA_ID}} | {{DMA_NAME}} | {{DMA_LOCATION}} | {{DMA_HOST}} | {{DMA_IP}} |
14+
15+
# Storage Infrastructure
16+
17+
<!-- REMOVABLE DESCRIPTION
18+
We can either describe the storage cluster's location and reference other documentation, or we can create a table that illustrates the general information of the nodes.
19+
-->
20+
### Cassandra Nodes
21+
| Server Name | IP Address |
22+
|--------------------|------------------|
23+
| {{CASSANDRA_NAME}} | {{CASSANDRA_IP}} |
24+
| {{CASSANDRA_NAME}} | {{CASSANDRA_IP}} |
25+
26+
### Opensearch Nodes
27+
28+
| Server Name | IP Address |
29+
|----------------|--------------|
30+
| {{OPENS_NAME}} | {{OPENS_IP}} |
3131
| {{OPENS_NAME}} | {{OPENS_IP}} |

‎articles/Overview/access.md ‎Projects/PRJNAME/Overview/access.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ description in case there are multiple DMSs. Below some examples of the typical
2323
> authentication method(send me a push or enter a password).
2424
> * After successful authentication it should start downloading {{VPN_CLIENT}} and install it in your PC, if you don't have it yet.
2525
> * The {{VPN_CLIENT}} should now indicate that you are connected as following:
26-
> ![pulse_vpn_client.png](../../images/pulse_vpn_client.png)
26+
> ![pulse_vpn_client.png](../../../images/_PRJNAME_/pulse_vpn_client.png)
2727
> * After successful VPN connection, RDP to jump servers and then from jump servers you can RDP to any server either under
2828
> {{DMS_CLUSTER_NAME}}cluster.

‎articles/Overview/overview.md ‎Projects/PRJNAME/Overview/overview.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
---
2-
uid: <PRJID>_overview_overview
3-
---
4-
# About {{PROJECT_NAME}}
5-
6-
## Value proposition
7-
A value proposition should clearly articulate the benefits and solutions the project brings to its users or stakeholders.
8-
It should emphasize how the delivered system addresses specific challenges, such as improving workflow efficiency,
9-
enhancing content delivery, ensuring reliability, or enabling the implementation of novel services.
10-
11-
The value proposition should highlight innovative features like automation, integration with existing
12-
broadcasting tools, or scalability to meet industry demands. It's important to communicate measurable outcomes,
13-
such as time savings, cost reductions, or quality improvements directly impacting broadcasting professionals and their operations.
14-
15-
## Delivered value
16-
There are multiple forms to express the delivered value, following some forms:
17-
18-
* **Detailed value description:** A brief paragraph describing how the solution solves the user's needs or problems.
19-
* **Bulleted list of key benefits:** A quick and easy-to-read list of the project's features or advantages.
20-
* **Infographics:** Graphical representations, such as charts, models, or workflows, to list the features or advantages.
21-
* **Comparative Improvements:** A list of the achieved improvements of any defined KPIs
22-
* **Customer phrases or outcomes:** Testimonials, use cases, or scenarios describing the success stories and how potential users can benefit
23-
24-
## Revision History
25-
26-
| Revision | Date | Name | Comments |
27-
|----------|-------------|----------|-----------------|
28-
| 001 | 26 Nov 2024 | John Doe | Initial Version |
29-
| 002 | 10 Dic 2024 | John Doe | Added section 2 |
1+
---
2+
uid: <PRJID>_overview_overview
3+
---
4+
# About {{PROJECT_NAME}}
5+
6+
## Value proposition
7+
A value proposition should clearly articulate the benefits and solutions the project brings to its users or stakeholders.
8+
It should emphasize how the delivered system addresses specific challenges, such as improving workflow efficiency,
9+
enhancing content delivery, ensuring reliability, or enabling the implementation of novel services.
10+
11+
The value proposition should highlight innovative features like automation, integration with existing
12+
broadcasting tools, or scalability to meet industry demands. It's important to communicate measurable outcomes,
13+
such as time savings, cost reductions, or quality improvements directly impacting broadcasting professionals and their operations.
14+
15+
## Delivered value
16+
There are multiple forms to express the delivered value, following some forms:
17+
18+
* **Detailed value description:** A brief paragraph describing how the solution solves the user's needs or problems.
19+
* **Bulleted list of key benefits:** A quick and easy-to-read list of the project's features or advantages.
20+
* **Infographics:** Graphical representations, such as charts, models, or workflows, to list the features or advantages.
21+
* **Comparative Improvements:** A list of the achieved improvements of any defined KPIs
22+
* **Customer phrases or outcomes:** Testimonials, use cases, or scenarios describing the success stories and how potential users can benefit
23+
24+
## Revision History
25+
26+
| Revision | Date | Name | Comments |
27+
|----------|-------------|----------|-----------------|
28+
| 001 | 26 Nov 2024 | John Doe | Initial Version |
29+
| 002 | 10 Dic 2024 | John Doe | Added section 2 |

‎articles/Overview/references.md ‎Projects/PRJNAME/Overview/references.md

File renamed without changes.

‎articles/toc.yml ‎Projects/PRJNAME/toc.yml

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
items:
2-
- name: Overview
3-
topicUid: <PRJID>_overview_overview
4-
items:
5-
- name: Access
6-
topicUid: <PRJID>_overview_access
7-
- name: References
8-
topicUid: <PRJID>_overview_references
9-
- name: Deployment
10-
topicUid: <PRJID>_deployment_deployment
11-
items:
12-
- name: High Level Architecture
13-
topicUid: <PRJID>_deployment_high_level_architecture
14-
- name: Infrastructure
15-
topicUid: <PRJID>_deployment_infrastructure
1+
items:
2+
- name: Overview
3+
topicUid: <PRJID>_overview_overview
4+
items:
5+
- name: Access
6+
topicUid: <PRJID>_overview_access
7+
- name: References
8+
topicUid: <PRJID>_overview_references
9+
- name: Deployment
10+
topicUid: <PRJID>_deployment_deployment
11+
items:
12+
- name: High Level Architecture
13+
topicUid: <PRJID>_deployment_high_level_architecture
14+
- name: Infrastructure
15+
topicUid: <PRJID>_deployment_infrastructure

‎images/components.png ‎images/PRJNAME/components.png

File renamed without changes.

‎images/interactions.png ‎images/PRJNAME/interactions.png

File renamed without changes.

‎images/pulse_vpn_client.png ‎images/PRJNAME/pulse_vpn_client.png

File renamed without changes.

‎index.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ Welcome to the project documentation template.
88

99
## Overview
1010

11-
- [Overview](xref:<PRJID>_overview_overview)
12-
- [Deployment](xref:<PRJID>_deployment_deployment)
11+
- [Overview](Projects/_PRJNAME_/Overview/overview.md)
12+
- [Deployment](Projects/_PRJNAME_/Deployment/deployment.md)
13+
- [Overview](xref:<PRJID>_overview_overview)

0 commit comments

Comments
 (0)