No Issue - Help Center Development Breakdown

breakdown.md

Index: breakdown.md
===================================================================
new file mode 100644
--- /dev/null
+++ b/breakdown.md
@@ -0,0 +1,65 @@
+# Help Center Development Breakdown
+
+[Specification](https://bitbucket.org/adblockplus/spec/src/5eef1222584c3a04802bd523d293f0bb58a5b5e4/spec/help-center/help-center.md?fileviewer=file-view-default)
+
+
+## Pages
+
+- Home

[ire, 2017/06/13 14:37:49]

This page isn't part of the current version

[juliandoucette, 2017/06/16 16:21:31]

We can remove this from the specification of this version.

[ire, 2017/06/19 14:09:02]

Acknowledged.

+- Adblock Plus Home, help.eyeo.com/adblockplus
+- Single Article Page, e.g. help.eyeo.com/adblockplus/block-all-ads
+- Search Results Page
+- Imprint, help.eyeo.com/legal
+
+
+## Templates
+
+- Help Center Home 

[juliandoucette, 2017/06/16 16:21:32]

See comment above.

[ire, 2017/06/19 14:09:02]

Acknowledged.

+- Product Help Home
+- Single Article
+- Search Results
+- Basic Page

[juliandoucette, 2017/06/16 16:21:31]

- This can be the default template
- Other templates can extend this one
(http://jinja.pocoo.org/docs/2.9/templates/#child-template)

[ire, 2017/06/19 14:09:02]

Yes we should have a default template, but here I was referring to a template
for a basic page, like the Imprint (I should probably use a different name as
it's confusing). This has a slightly different layout to other pages, so it
should itself extend from the default template we create

+
+
+## Components
+
+- General Navigation
+- Site Search Bar

[juliandoucette, 2017/06/16 16:21:31]

NIT: This is a field not a bar.

[ire, 2017/06/19 14:09:02]

Acknowledged.

+- Topics Group
+- Contact Section
+- Breadcrumb

[juliandoucette, 2017/06/16 16:21:32]

NIT: Breadcrumb**s** or Breadcrumb bar?

[ire, 2017/06/19 14:09:02]

I think "Breadcrumbs"

+- Accordion Menu
+- Browser Selector with Browser Detection
+- Card
+- Search Result Item
+- Lists (Ordered Lists, Unordered Lists, "Numbered" Lists)

[juliandoucette, 2017/06/16 16:21:31]

It's not clear to me whether there should also be "*Underlined* Lists" (The
Topic Group, Accordion Menu, and Search Result lists are quite similar in
style).

[ire, 2017/06/19 14:09:02]

Yes you're right there's definitely a pattern there. I'll add that.

+
+- Grid
+- Variables
+- Typography
+
+
+### General Navigation
+
+[See Spec](https://bitbucket.org/adblockplus/spec/src/5eef1222584c3a04802bd523d293f0bb58a5b5e4/spec/help-center/help-center.md?fileviewer=file-view-default#markdown-header-general-navigation)
+
+This includes:

[juliandoucette, 2017/06/16 16:21:31]

Why did you group the header navbar and the footer navbar into the same
component? I think they are separate includes. And, by extension, separate
components. But this may just be a misunderstanding of what we mean by
"component" here.

[ire, 2017/06/19 14:09:02]

Yeah they will be separate includes. I was mostly following the way it was
defined in the specification, but I'll separate them.

+- Logo (in header)
+- Product Website Link (in header)
+- Language Selector (in footer)
+- Footer Links (in footer)
+
+Note: The header has a slighlty different layout depening on if it is within a specific product's page (e.g. Single Article) or a general page (e.g. Basic Page)

[juliandoucette, 2017/06/16 16:21:32]

Thanks for pointing this out.

[ire, 2017/06/19 14:09:02]

You're welcome :)

+
+
+### Topics Group
+
+This is a list of topics. There are two instances:
+
+- Within a card, e.g. the "Popular Topics" ([See Spec](https://bitbucket.org/adblockplus/spec/src/5eef1222584c3a04802bd523d293f0bb58a5b5e4/spec/help-center/help-center.md?fileviewer=file-view-default#markdown-header-popular-topics))
+- Within a group of other "Topics Groups", e.g. on the Product Help Home page ([See Spec](https://bitbucket.org/adblockplus/spec/src/5eef1222584c3a04802bd523d293f0bb58a5b5e4/spec/help-center/help-center.md?fileviewer=file-view-default#markdown-header-help-categories))
+
+
+### Lists
+
+What I am calling "Numbered Lists" refers to the lists that have styled numbers as shown [here](https://bytebucket.org/adblockplus/spec/raw/5eef1222584c3a04802bd523d293f0bb58a5b5e4/res/help-center/abp-help-article.jpg). This will be implemented as an ordered list `ol`, but I'm making the distinction here to differentiate that style from other ordered lists.