Skip to content

Commit

Permalink
Update 0.3.0 docs(#125)
Browse files Browse the repository at this point in the history
Update 0.3.0 docs
  • Loading branch information
erssebaggala authored Oct 8, 2019
2 parents 0f93426 + f3c888e commit 2f63fe8
Show file tree
Hide file tree
Showing 41 changed files with 889 additions and 11 deletions.
18 changes: 18 additions & 0 deletions docs/baseline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
id: baseline
title: Baseline Audit
sidebar_label: Baseline Audit
---

The baseline module automatically computes a network baseline and generates a comparison report. The baseline is computed by grouping
GSM cells by BSCs, WCDMA/UMTS cells by RNC, and LTE cells by tracking area.

To run the baseline, first import your data through the "**Parse and Import**" module.
Then launch the **Baseline Audit** module. Once there, click run baseline to generate network baseline.


![GIS Module](/bts-ce-lite/img/baseline_module.png)

The generated comparison report can be viewed under the **Baseline Audit** reports folder in the reports module tree.

![GIS Module](/bts-ce-lite/img/baseline_comparison_report.png)
24 changes: 22 additions & 2 deletions docs/gis.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,28 @@ title: GIS
sidebar_label: GIS
---

This GIS module displays network entities and their properties on map. It allows filtering based on technology, name, and environment.
This GIS module displays cells and sites and their properties on a map. It allows filtering based on technology, name, and environment.

Below is a screenshot of the GIS module.

![GIS Module](/bts-ce-lite/img/gis.jpeg)
![GIS Module](/bts-ce-lite/img/gis.jpeg)

## Importing data
Currently, we can import boda cell files(structure is avialable in the import and load documentation) and TEMS CEL and XML files for GSM, WCDMA, and LTE. To import data,
launch the GIS module, click the **data icon** on the left menu to see import options. Select the import file format and optionaly
specify whether to first clear the old data before loading the new data.
shows how to
![Import data into Map](/bts-ce-lite/img/gis_import_data.png)

## Filtering cells
It's important to filter the cells on the map so that you can concentrate on the key cells you want to view.
Filtering can be donw by selecting the technology, or searching for a cell's name vie the filter search text field. The search
text fields accepts regular expressions for complex filtering criteria.

![Filtering cells on the map](/bts-ce-lite/img/gis_filter_cells.png)

## Editing display properties
The property edit pane allows your to set the sector radius per technology and specify the
color used for each carrier frequency.

![Update sector colors](/bts-ce-lite/img/gis_update_carrier_colors.png)
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Boda-Lite is a multi-vendor network management desktop application. It is a mini
- [Parse and Import](parse_and_import.md)
- [Reports](reports.md)
- [GIS](gis.md)
- [Baseline](baseline.md)
- [Utilities](utilities.md)
- [Key Files and Folders](key_files_and_folders.md)
- [Contributing](contributing.md)
- [Development](development.md)
Expand Down
3 changes: 2 additions & 1 deletion docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Below is a summary of the steps needed to install and start the application:
* Parsing and import of configuration management(CM), performance management(PM) and fault management(FM) network dumps
* Reports module that supports tabular, various graphical reports and composite/dashboard like reports
* Advanced GIS module
* Importation of planning network data
* Importation of planning network data through boda cell file
* Useful utilities such as combining csv files to excel


## Planned functionality
Expand Down
11 changes: 11 additions & 0 deletions docs/utilities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: utilities
title: Utilities
sidebar_label: Utilities
---


## Combine CSV files into a excel workbook
The **CSV to Excel Combiner** utility combines a list of csv files into one excel workbook with each file on a separate worksheet.

![GIS Module](/bts-ce-lite/img/csv_to_excel_combiner.png)
Binary file modified libraries/boda-bulkcmparser.jar
Binary file not shown.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Boda-Lite",
"version": "0.3.0-rc.1",
"version": "0.3.0",
"description": "Boda-Lite is a telecommunication network management application",
"private": true,
"homepage": "./",
Expand Down
5 changes: 3 additions & 2 deletions src/modules/gis/GISMap.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ import { FiHome,
FiRadio,
FiArrowRight,
FiShare2,
FiDatabase } from "react-icons/fi";
FiDatabase,
FiFilter } from "react-icons/fi";
import 'leaflet-contextmenu'
import 'leaflet-contextmenu/dist/leaflet.contextmenu.css'
import 'leaflet.icon.glyph'
Expand Down Expand Up @@ -578,7 +579,7 @@ class GISMap extends React.Component{
onOpen={this.onSideBarOpen.bind(this)}
onClose={this.onSideBarClose.bind(this)}
>
<Tab id="gis_search" header="Filter" icon={<FiSearch />}>
<Tab id="gis_search" header="Filter" icon={<FiFilter />}>
<div className="mt-2">
<FormGroup
label=""
Expand Down
4 changes: 4 additions & 0 deletions src/modules/utilities/CSVToExcelCombiner.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ export default class CSVToExcelCombiner extends React.Component {
this.combinerListener = null;
}

dismissNotice = () => {
this.setState({notice: null});
}

showFiles = () => {
if (!fs.existsSync(this.state.inputFolder)) {
this.setState({errorMessage: `${this.state.inputFolder} does not exist`})
Expand Down
2 changes: 1 addition & 1 deletion src/version.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export const VERSION = "0.3.0-rc.1";
export const VERSION = "0.3.0";

export default VERSION;
23 changes: 23 additions & 0 deletions website/blog/2019-10-08-new-version-0.3.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Version 0.3.0 Release
author: Emmanuel Robert Ssebaggala
authorURL: https://www.ssegga.com
---

0.3.0 is now available. Below are changes
* Baseline computation
* Added GIS module that supports boda cell file and TEMS CEL and XML files
* Added csv to excel combiner
* Preserve column ordering when reports are exported
* Update documentation with boda cell file structure
* Added relations reports
* Tracking documetation with releases
* Parsing and loading of Ericsson EAW printous added
* Parsing of Motorola Cell X Export dumps
* Processing and loading of Ericsson, Huawei, and Nokia PM
* Added database migrations scripts
* Parsing and loading of Ericsson BSM inventory dumps
* Parsing and loading of Huawei AUTOBAK XML files
* Added relations reports
* Added combined key parameter report
* Added table styling during report creation
64 changes: 64 additions & 0 deletions website/i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
"previous": "Previous",
"tagline": "Multi-vendor/technology desktop telecommunication management app",
"docs": {
"baseline": {
"title": "Baseline Audit",
"sidebar_label": "Baseline Audit"
},
"contributing": {
"title": "Contributing",
"sidebar_label": "Contributing"
Expand Down Expand Up @@ -40,6 +44,66 @@
"reports": {
"title": "Reports",
"sidebar_label": "Reports"
},
"utilities": {
"title": "Utilities",
"sidebar_label": "Utilities"
},
"version-0.3.0/version-0.3.0-baseline": {
"title": "Baseline Audit",
"sidebar_label": "Baseline Audit"
},
"version-0.3.0/version-0.3.0-gis": {
"title": "GIS",
"sidebar_label": "GIS"
},
"version-0.3.0/version-0.3.0-index": {
"title": "Contents",
"sidebar_label": "Table of contents"
},
"version-0.3.0/version-0.3.0-introduction": {
"title": "Introduction",
"sidebar_label": "Introduction"
},
"version-0.3.0/version-0.3.0-utilities": {
"title": "Utilities",
"sidebar_label": "Utilities"
},
"version-2.3.0/version-2.3.0-contributing": {
"title": "Contributing",
"sidebar_label": "Contributing"
},
"version-2.3.0/version-2.3.0-development": {
"title": "Development",
"sidebar_label": "Development Guide"
},
"version-2.3.0/version-2.3.0-gis": {
"title": "GIS",
"sidebar_label": "GIS"
},
"version-2.3.0/version-2.3.0-index": {
"title": "Contents",
"sidebar_label": "Table of contents"
},
"version-2.3.0/version-2.3.0-installation": {
"title": "Installation",
"sidebar_label": "Installation"
},
"version-2.3.0/version-2.3.0-introduction": {
"title": "Introduction",
"sidebar_label": "Introduction"
},
"version-2.3.0/version-2.3.0-key_files_and_folders": {
"title": "Key Files and Folders",
"sidebar_label": "Key Files and Folders"
},
"version-2.3.0/version-2.3.0-parse_and_import": {
"title": "Parse and Import",
"sidebar_label": "Parse and Import"
},
"version-2.3.0/version-2.3.0-reports": {
"title": "Reports",
"sidebar_label": "Reports"
}
},
"links": {
Expand Down
23 changes: 22 additions & 1 deletion website/pages/en/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class HomeSplash extends React.Component {
<div className="inner">
<ProjectTitle siteConfig={siteConfig} />
<PromoSection>
<Button href="https://github.com/bodastage/bts-ce-lite/releases/tag/v0.2.3">Download v0.2.3</Button>
<Button href="https://github.com/bodastage/bts-ce-lite/releases/tag/v0.3.0">Download v0.3.0</Button>
<Button href={docUrl('introduction.html#quick-start')}>Quick start</Button>
</PromoSection>
</div>
Expand Down Expand Up @@ -203,6 +203,26 @@ class Index extends React.Component {
);
};

const Sponsors = () => {

const showcase = [
{name: "Bodastage Solutions", siteUrl: "https://www.bodastage.com", logoUrl: '/bts-ce-lite/img/bodastage_logo.png'},
{name: "Telecomhall", siteUrl: "https://www.telecomhall.net", logoUrl: '/bts-ce-lite/img/telecomhall_forum_Logo.png'}
].map(sp => (
<a href={sp.siteUrl} key={sp.siteUrl}>
<img src={sp.logoUrl} alt={sp.name} title={sp.name} />
</a>
));

return (
<div className="productShowcaseSection paddingBottom">
<h2>Sponsors</h2>
<p>This project is sponsored by</p>
<div className="logos">{showcase}</div>
</div>
);
};

return (
<div>
<HomeSplash siteConfig={siteConfig} language={language} />
Expand All @@ -213,6 +233,7 @@ class Index extends React.Component {
<ReportsBlock />
<GISBlock />
<Showcase />
<Sponsors />
</div>
</div>
);
Expand Down
118 changes: 118 additions & 0 deletions website/pages/en/versions.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
/**
* Copyright (c) 2017-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

const React = require('react');

const CompLibrary = require('../../core/CompLibrary');

const Container = CompLibrary.Container;

const CWD = process.cwd();

const versions = require(`${CWD}/versions.json`);

function Versions(props) {
const {config: siteConfig} = props;
const latestVersion = versions[0];
const repoUrl = `https://github.com/${siteConfig.organizationName}/${
siteConfig.projectName
}`;
return (
<div className="docMainWrapper wrapper">
<Container className="mainContainer versionsContainer">
<div className="post">
<header className="postHeader">
<h1>{siteConfig.title} Versions</h1>
</header>
<p>New versions of this project are released every so often.</p>
<h3 id="latest">Current version (Stable)</h3>
<table className="versions">
<tbody>
<tr>
<th>{latestVersion}</th>
<td>
{/* You are supposed to change this href where appropriate
Example: href="<baseUrl>/docs(/:language)/:id" */}
<a
href={`${siteConfig.baseUrl}${siteConfig.docsUrl}/${
props.language ? props.language + '/' : ''
}doc1`}>
Documentation
</a>
</td>
<td>
<a href="">Release Notes</a>
</td>
</tr>
</tbody>
</table>
<p>
This is the version that is configured automatically when you first
install this project.
</p>
<h3 id="rc">Pre-release versions</h3>
<table className="versions">
<tbody>
<tr>
<th>master</th>
<td>
{/* You are supposed to change this href where appropriate
Example: href="<baseUrl>/docs(/:language)/next/:id" */}
<a
href={`${siteConfig.baseUrl}${siteConfig.docsUrl}/${
props.language ? props.language + '/' : ''
}next/doc1`}>
Documentation
</a>
</td>
<td>
<a href={repoUrl}>Source Code</a>
</td>
</tr>
</tbody>
</table>
<p>Other text describing this section.</p>
<h3 id="archive">Past Versions</h3>
<p>Here you can find previous versions of the documentation.</p>
<table className="versions">
<tbody>
{versions.map(
version =>
version !== latestVersion && (
<tr>
<th>{version}</th>
<td>
{/* You are supposed to change this href where appropriate
Example: href="<baseUrl>/docs(/:language)/:version/:id" */}
<a
href={`${siteConfig.baseUrl}${siteConfig.docsUrl}/${
props.language ? props.language + '/' : ''
}${version}/doc1`}>
Documentation
</a>
</td>
<td>
<a href={`${repoUrl}/releases/tag/v${version}`}>
Release Notes
</a>
</td>
</tr>
),
)}
</tbody>
</table>
<p>
You can find past versions of this project on{' '}
<a href={repoUrl}>GitHub</a>.
</p>
</div>
</Container>
</div>
);
}

module.exports = Versions;
Loading

0 comments on commit 2f63fe8

Please sign in to comment.