Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a comparison page to the site. #30

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add a comparison page to the site. #30

wants to merge 2 commits into from

Conversation

schmidtw
Copy link
Member

No description provided.

Copy link
Contributor

@kristinapathak kristinapathak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks good. It would be nice to see a screenshot of how the table looks on the page. Also, there is a page added to every doc page's navigation but not included in this PR, which needs to be fixed before this is merged.

content/docs/introduction/comparison.md Outdated Show resolved Hide resolved

Xmidt by design is **not** coupled with any data models.
This allows for inclusion of all manor of data models. TR-181, TR-104, custom
Msgpack or JSON are all no problem. Any system tightly coupled with one of the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Msgpack or JSON are all no problem. Any system tightly coupled with one of the
Msgpack and JSON are all no problem. Any system tightly coupled with one of the


# Comparisons

We are often asked how Xmidt+Webpa compares to some alternative. It's a great
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We are often asked how Xmidt+Webpa compares to some alternative. It's a great
We are often asked how XMiDT+WebPA compares to some alternative. It's a great

# Comparisons

We are often asked how Xmidt+Webpa compares to some alternative. It's a great
question. By itself Xmidt is difficult to compare directly to other systems
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
question. By itself Xmidt is difficult to compare directly to other systems
question. By itself, XMiDT is difficult to compare directly to other systems

primarily due to the fundamental differences in architecture & different project
goals.

Xmidt by design is **not** coupled with any data models.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Xmidt by design is **not** coupled with any data models.
XMiDT by design is **not** coupled with any data models.


* `[1]` - This is an optional 'à la carte' Xmidt feature where one available approach is to use `partner-id`.
* `[2]` - Depends on your vendor.
* `[3]` - Xmidt behavior confirmed by the Comcast team.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `[3]` - Xmidt behavior confirmed by the Comcast team.
* `[3]` - XMiDT behavior confirmed by the Comcast team.


# Comparisons

We are often asked how Xmidt+Webpa compares to some alternative. It's a great
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be nice to explain what XMiDT and WebPA are briefly, to make it clear why here at the beginning we are saying "XMiDT+WebPA" but towards the end we're only talking about XMiDT.

Comment on lines +41 to +59
| Category | TR-069<sup>[2]</sup> | USP<sup>[2]</sup> | Xmidt+Webpa |
|:------------------------------------------------------------------|:--------------------------------------------:|:---------------------------------------------:|:----------------------------------------:|
|End-to-End Open Source Solution | <i class="fas fa-times-circle no"></i> | <i class="fas fa-times-circle no"></i> | <i class="fas fa-check-circle yes"></i> |
|All Components Available via Business Friendly Apache 2.0 License | <i class="fas fa-times-circle no"></i> | <i class="fas fa-times-circle no"></i> | <i class="fas fa-check-circle yes"></i> |
|Zero Licensing Costs | <i class="fas fa-times-circle no"></i> | <i class="fas fa-times-circle no"></i> | <i class="fas fa-check-circle yes"></i> |
|Inclusive and Extensible Ecosystem at Client or Server Levels | <i class="fas fa-times-circle no"></i> | <i class="fas fa-times-circle no"></i> | <i class="fas fa-check-circle yes"></i> |
|Supports Multiple Management Servers | <i class="fas fa-times-circle no"></i> | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> |
|Has Efficient Data Encoding | <i class="fas fa-times-circle no"></i> | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> |
|Has an Always-On Communication Mechanism | <i class="fas fa-times-circle no"></i> | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> |
|Utilizes a Device:2 (TR-181i2) Driven Data Model | <i class="fas fa-times-circle no"></i> | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> |
|Schema Drive Protocol Definition | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> |
|Defines a Robust Set of Operations | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> |
|May Leverage a Transport Layer Security Mechanism | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> |
|Provides an Access Control Mechanism<sup>[1]</sup> | 1/2 | <i class="fas fa-check-circle yes"></i> | <i class="fas fa-check-circle yes"></i> |
|Provides a Secure Clean/Screen Solution for 3rd Party Services | <i class="fas fa-times-circle no"></i> | <i class="fas fa-times-circle no"></i> | <i class="fas fa-check-circle yes"></i> |
|Easy to Scale (100 - +50M CPEs)<sup>[3]</sup> | <i class="fas fa-times-circle no"></i> | <i class="fas fa-question-circle maybe"></i> | <i class="fas fa-check-circle yes"></i> |
|Easy to Scale (100 - +100K events/second)<sup>[3]</sup> | <i class="fas fa-times-circle no"></i> | <i class="fas fa-question-circle maybe"></i> | <i class="fas fa-check-circle yes"></i> |
|Upgradable Without Outages at Scale<sup>[3]</sup> | <i class="fas fa-question-circle maybe"></i> | <i class="fas fa-question-circle maybe"></i> | <i class="fas fa-check-circle yes"></i> |
|Functions Properly With Complete Datacenter Failure<sup>[3]</sup> | <i class="fas fa-question-circle maybe"></i> | <i class="fas fa-question-circle maybe"></i> | <i class="fas fa-check-circle yes"></i> |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be nice to explain how XMiDT accomplishes some of these things? Not sure that we want to include that on this page, but maybe another page where we go into some amount of detail explaining how we check each of these boxes and more information about how to set XMiDT up to accomplish these things. It can help add credibility to our claims.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good points. I'll see if I can do better with this.

@@ -81,7 +81,7 @@
<div class="col-md-3 side-nav-col">
<ul class="nav navbar-nav side-nav">

<li><span class="nav-header"><i class="fa fa-hand-o-right"></i> <span>Introduction</span></span><ul class="nav "><li><a href="/docs/introduction/overview/">Overview</a></li><li><a href="/docs/introduction/glossary/">Glossary</a></li></ul></li>
<li><span class="nav-header"><i class="fa fa-hand-o-right"></i> <span>Introduction</span></span><ul class="nav "><li><a href="/docs/introduction/ecosystem/">Ecosystem</a></li><li><a href="/docs/introduction/overview/">Overview</a></li><li><a href="/docs/introduction/comparison/">Comparison to alternatives</a></li><li><a href="/docs/introduction/glossary/">Glossary</a></li></ul></li>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see Ecosystem in the navigation, but not in the included files of this PR. Can you either add the file in the PR or move it elsewhere and re-build the site?

Also - Overview is second. Is that the order what we want? Usually we put the Overview first in the navigation because it's more of the introductory page.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a mistake - I had that change in the same branch & didn't realize it impacted the output.

@@ -0,0 +1,66 @@
---
title: Comparison to alternatives
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: Comparison to alternatives
title: Comparison to Alternatives

@kristinapathak kristinapathak changed the base branch from master to main July 28, 2020 02:48
@sonarcloud
Copy link

sonarcloud bot commented Mar 22, 2022

SonarCloud Quality Gate failed.    Quality Gate failed

Bug C 364 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell B 163 Code Smells

No Coverage information No Coverage information
24.6% 24.6% Duplication

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants