Add a comparison page to the site. #30

schmidtw · 2019-10-21T13:39:56Z

No description provided.

kristinapathak

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

kristinapathak · 2019-10-21T16:07:36Z

content/docs/introduction/comparison.md

+
+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


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

kristinapathak · 2019-10-21T16:07:57Z

content/docs/introduction/comparison.md

+
+# Comparisons
+
+We are often asked how Xmidt+Webpa compares to some alternative.  It's a great


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

kristinapathak · 2019-10-21T16:08:25Z

content/docs/introduction/comparison.md

+# 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


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

kristinapathak · 2019-10-21T16:09:03Z

content/docs/introduction/comparison.md

+primarily due to the fundamental differences in architecture & different project
+goals.
+
+Xmidt by design is **not** coupled with any data models.


Suggested change

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

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

kristinapathak · 2019-10-21T16:30:46Z

content/docs/introduction/comparison.md

+
+* `[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.


Suggested change

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

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

kristinapathak · 2019-10-21T16:31:58Z

content/docs/introduction/comparison.md

+
+# Comparisons
+
+We are often asked how Xmidt+Webpa compares to some alternative.  It's a great


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.

kristinapathak · 2019-10-21T16:34:04Z

content/docs/introduction/comparison.md

+| 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> |


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.

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

kristinapathak · 2019-10-21T16:43:27Z

docs/docs/codex/fenrir/getting_started/index.html

@@ -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>


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.

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

kristinapathak · 2019-10-21T16:43:59Z

content/docs/introduction/comparison.md

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


Suggested change

title: Comparison to alternatives

title: Comparison to Alternatives

Co-authored-by: Kristina Pathak <kmspring57@gmail.com>

sonarcloud · 2022-03-22T16:34:11Z

SonarCloud Quality Gate failed.

364 Bugs
0 Vulnerabilities
0 Security Hotspots
163 Code Smells

No Coverage information
24.6% Duplication

Add a comparison page to the site.

884dd41

schmidtw requested a review from kristinapathak October 21, 2019 13:39

kristinapathak requested changes Oct 21, 2019

View reviewed changes

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

Update content/docs/introduction/comparison.md

ae385c5

Co-authored-by: Kristina Pathak <kmspring57@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a comparison page to the site. #30

Add a comparison page to the site. #30

schmidtw commented Oct 21, 2019

kristinapathak left a comment

kristinapathak Oct 21, 2019

kristinapathak Oct 21, 2019

kristinapathak Oct 21, 2019

kristinapathak Oct 21, 2019

kristinapathak Oct 21, 2019

kristinapathak Oct 21, 2019

kristinapathak Oct 21, 2019

schmidtw Oct 22, 2019

kristinapathak Oct 21, 2019

schmidtw Oct 22, 2019

kristinapathak Oct 21, 2019

sonarcloud bot commented Mar 22, 2022

	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

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

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

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

	title: Comparison to alternatives
	title: Comparison to Alternatives

Add a comparison page to the site. #30

Are you sure you want to change the base?

Add a comparison page to the site. #30

Conversation

schmidtw commented Oct 21, 2019

kristinapathak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Mar 22, 2022