Skip to content

Commit 164dc20

Browse files
author
Lauren
authored
Merge pull request #2380 from basho/great_rework/aggregate
Great Rework -- Aggregate
2 parents 73f712b + b3c82ed commit 164dc20

File tree

488 files changed

+32522
-19686
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

488 files changed

+32522
-19686
lines changed

Diff for: ‎CONTRIBUTING.md

+2-14
Original file line numberDiff line numberDiff line change
@@ -212,19 +212,13 @@ canonical_link: "https://docs.basho.com/. . ." # 10 -- Conditional
212212
9. The canonical URI for the page
213213
214214
If this element is excluded, the canonical URI will default to
215-
`${project_path}/latest/${project_relative_url}`. **If this is
215+
`${project_path}/latest/${project_relative_path}`. **If this is
216216
not what the canonical link should be, this element is required**.
217217
218218
This is especially important to look out for when moving pages between
219219
versions. **The most recent location of any given page should be its
220220
canonical link.**
221221
222-
**FIXME**: Actually, this is a lie. Our current head.html partial doesn't
223-
include a default value for the canonical links. Changes should
224-
be made to layout/partials/head.html (or maybe
225-
layout/partials/common_variables.html?) to bring our behavior up
226-
to scratch.
227-
228222
10. "Redirects can be handled easily with aliases in Hugo."
229223
230224
https://gohugo.io/extras/aliases/
@@ -310,15 +304,9 @@ canonical_link: "https://docs.basho.com/. . ." # 2 -- OPTIONAL
310304
be** `community`.
311305
312306
2. Default canonical links for Community pages are slightly different from and
313-
simpler than primary content pages; `community/${project_relative_url}`.
307+
simpler than primary content pages; `community/${project_relative_path}`.
314308
Again, this element is entirely optional.
315309
316-
**FIXME**: Actually, this is (also) a lie. We're currently using the same
317-
old head.html partial to generate community pages <head> tags.
318-
We should build a new layout/partials/community/head.html (and
319-
maybe a layout/partials/community/common_variables.html?) to
320-
handle the stated differences.
321-
322310
323311
## Problematic Markdown (and Workarounds)
324312

Diff for: ‎Gemfile

+6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
source "https://rubygems.org"
22
ruby "2.2.5"
33

4+
#TOOD: This file is now out of date.
5+
# We need to walk the gems and make sure that,
6+
# 1. Each gem is current
7+
# 2. Each gem is _used_
8+
49
gem "sass", "~>3.4.22"
10+
gem "autoprefixer-rails", "~>6.3.6"
511
gem "sass-css-importer", ">=1.0.0.beta.0"
612
gem "compass", "~>1.0.3"
713
gem "sprockets", "~>3.7"

Diff for: ‎config.yaml

+47-21
Original file line numberDiff line numberDiff line change
@@ -40,53 +40,78 @@ params:
4040
#
4141
# The map should contain elements in the form,
4242
#
43-
# <project_name>: /* 1 */
44-
# path: "<path>" /* 2 */
45-
# archived_path: "<path>"
46-
# releases: /* 3 */
43+
# <project_desc>: /* 1 */
44+
# project_name: "<Title Name>" /* 2 */
45+
# project_name_html: '<HTML>' /* 2 */
46+
# path: "<path>" /* 3 */
47+
# archived_path: "<path>" /* 3 */
48+
# releases: /* 4 */
4749
# - ["<version>", "<version>", ...]
4850
# - ["<version>", "<version>", ...]
49-
# latest: "<version>" /* 4 */
50-
# lts: "<version>"
51-
# archived_url: "<URI>" /* 5 */
51+
# latest: "<version>" /* 5 */
52+
# lts: "<series>" /* 6 */
53+
# archived_url: "<URI>" /* 7 */
5254
#
53-
# 1. The project name must match some contents' `project:` front matter
54-
# 2. The `path` is the on-disk relative path from the content root. In Hugo,
55-
# the content root is '/content/', on S3 the root is simply '/'.
55+
# 1. The project descriptor must match some contents' `project:` front matter.
56+
# This should be all lowercase with underscores for spaces---code, really.
57+
# 2. A reader-friendly project name and an HTML-friendly project title.
58+
# Spaces and caps are welcome in the name. ex; if the `project_desc` is
59+
# `riak_kv`, the `project_name` Could be `"Riak KV"`.
60+
# The HTML is expected to be wrapped in a .product__title <div> with a logo
61+
# icon prepended, so only the name of the product itself should be
62+
# recorded. This is a very fragile element. See below for examples.
63+
# `project_name` is required.`project_name_html` is optional.
64+
# NB. Currently the areas that this title is used are spatially small. As
65+
# such the titles should be kept below ~12 characters. "DataPlatform" is
66+
# the text these elements were sized with.
67+
# 3. The `path` is the on-disk relative path from the content root. In Hugo,
68+
# the content root is '/content/', on S3 the root is simply '/'.
5669
# If the project was moved from the Middleman site to Hugo, the
57-
# `archived_path` is the on-disk relative path of the previous directory.
70+
# `archived_path` is the on-disk relative path of the previous directory.
71+
# `path` is required. `archived_path` is optional. (Or should be?)
5872
# TODO: `archived_path` should probably be optional. I don't believe it
5973
# currently is.
60-
# 3. The `releases` list-of-lists is organized oldest to newest, grouped by
74+
# 4. The `releases` list-of-lists is organized oldest to newest, grouped by
6175
# release set (ex. the 2.0.* series is one list, followed b the 2.1.*
62-
# series).
63-
# 4. `latest` and `lts` versions are the current head-of-development and long-
64-
# term-support releases respectively. `lts` is optional.
65-
# TODO: These should probably be release sets, not a specific version.
66-
# 5. If the project was moved from the Middleman site to Hugo, the
67-
# `archived_url` is the URL to the newest deprecated page.
68-
# This option is optional.
76+
# series).
77+
# `releases` is required. Every release must have at least one `version`.
78+
# 5. `latest` is the current specific version that is currently att the head-
79+
# of-development.
80+
# `latest` is required.
81+
# 6. `lts` is the Release Series (ex; "1.4", or "2.0", ect. -- it is expected
82+
# to be the "X.Y" of a semantic "X.Y.Z" version string) that is currently
83+
# held as the Long Term Support series.
84+
# `lts` is optional.
85+
# 7. If the project was moved from the Middleman site to Hugo, the
86+
# `archived_url` is the URL to the newest of the deprecated pages.
87+
# `archived_url` is optional.
6988
project_descriptions:
7089
riak_kv:
90+
project_name: "Riak KV"
91+
project_name_html: 'Riak<span class="product__title-highlight">KV</span>'
7192
path: "/riak/kv"
7293
archived_path: "/riak"
7394
releases:
7495
- ["2.0.0", "2.0.1", "2.0.2", "2.0.4", "2.0.5", "2.0.6", "2.0.7"]
7596
- ["2.1.1", "2.1.3", "2.1.4"]
7697
- ["2.2.0"]
7798
latest: "2.2.0"
78-
lts: "2.0.7"
99+
lts: "2.0"
79100
archived_url: "http://docs.basho.com/riak/1.4.12/"
80101
riak_cs:
102+
project_name: "Riak CS"
103+
project_name_html: 'Riak<span class="product__title-highlight">CS</span>'
81104
path: "/riak/cs"
82105
archived_path: "/riakcs"
83106
releases:
84107
- ["2.0.0", "2.0.1"]
85108
- ["2.1.0", "2.1.1"]
86109
latest: "2.1.1"
87-
lts: "2.0.1"
110+
lts: "2.0"
88111
archived_url: "http://docs.basho.com/riakcs/1.5.4/"
89112
riak_ts:
113+
project_name: "Riak TS"
114+
project_name_html: 'Riak<span class="product__title-highlight">TS</span>'
90115
path: "/riak/ts"
91116
archived_path: "/riakts"
92117
releases:
@@ -98,6 +123,7 @@ params:
98123
- ["1.5.0", "1.5.1"]
99124
latest: "1.5.1"
100125
dataplatform:
126+
project_name: "DataPlatform"
101127
path: "/dataplatform"
102128
archived_path: "/dataplatform"
103129
releases:

Diff for: ‎content/community/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Community"
77
identifier: "community_overview"
88
weight: 600
9-
pre: icon-comments
9+
pre: comments
1010
aliases:
1111
- /riak/latest/community
1212
- /riak/2.1.4/community

Diff for: ‎content/dataplatform/1.0.0/configuring.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ menu:
88
name: "Configuring"
99
identifier: "configuring"
1010
weight: 103
11-
pre: icon-configure
11+
pre: configure
1212
toc: true
1313
---
1414

Diff for: ‎content/dataplatform/1.0.0/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ menu:
88
name: "Basho Data Platform"
99
identifier: "index"
1010
weight: 100
11-
pre: icon-riak
11+
pre: riak
1212
toc: false
1313
---
1414

Diff for: ‎content/dataplatform/1.0.0/learn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ menu:
88
name: "Learn"
99
identifier: "learn"
1010
weight: 105
11-
pre: icon-beaker
11+
pre: beaker
1212
toc: false
1313
aliases:
1414
- /dataplatform/1.0.0/learn-about-dataplatform/learn-about-dataplatform/

Diff for: ‎content/dataplatform/1.0.0/using.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ menu:
88
name: "Using"
99
identifier: "using"
1010
weight: 104
11-
pre: icon-database
11+
pre: database
1212
toc: true
1313
aliases:
1414
- /dataplatform/1.0.0/using-dataplatform/using-dataplatform/

Diff for: ‎content/riak/cs/2.0.0/cookbooks/multi-datacenter-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Riak CS Enterprise"
77
identifier: "mdc_overview"
88
weight: 600
9-
pre: icon-cloud
9+
pre: cloud
1010
project: "riak_cs"
1111
project_version: "2.0.0"
1212
aliases:

Diff for: ‎content/riak/cs/2.0.0/developing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Developing"
77
identifier: "develop"
88
weight: 200
9-
pre: icon-lambda
9+
pre: lambda
1010
project: "riak_cs"
1111
project_version: "2.0.0"
1212
---

Diff for: ‎content/riak/cs/2.0.0/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Riak CS"
77
identifier: "index"
88
weight: 100
9-
pre: icon-bolt
9+
pre: bolt
1010
project: "riak_cs"
1111
project_version: "2.0.0"
1212
aliases:

Diff for: ‎content/riak/cs/2.0.0/operating.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Operating"
77
identifier: "ops"
88
weight: 300
9-
pre: icon-database
9+
pre: database
1010
project: "riak_cs"
1111
project_version: "2.0.0"
1212
---

Diff for: ‎content/riak/cs/2.0.0/reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Reference"
77
identifier: "reference"
88
weight: 500
9-
pre: icon-references
9+
pre: references
1010
project: "riak_cs"
1111
project_version: "2.0.0"
1212
---

Diff for: ‎content/riak/cs/2.0.0/theory.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Theory & Concepts"
77
identifier: "theory"
88
weight: 400
9-
pre: icon-beaker
9+
pre: beaker
1010
project: "riak_cs"
1111
project_version: "2.0.0"
1212
---

Diff for: ‎content/riak/cs/2.0.1/cookbooks/multi-datacenter-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Riak CS Enterprise"
77
identifier: "mdc_overview"
88
weight: 600
9-
pre: icon-cloud
9+
pre: cloud
1010
project: "riak_cs"
1111
project_version: "2.0.1"
1212
aliases:

Diff for: ‎content/riak/cs/2.0.1/developing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Developing"
77
identifier: "develop"
88
weight: 200
9-
pre: icon-lambda
9+
pre: lambda
1010
project: "riak_cs"
1111
project_version: "2.0.1"
1212
---

Diff for: ‎content/riak/cs/2.0.1/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Riak CS"
77
identifier: "index"
88
weight: 100
9-
pre: icon-bolt
9+
pre: bolt
1010
project: "riak_cs"
1111
project_version: "2.0.1"
1212
aliases:

Diff for: ‎content/riak/cs/2.0.1/operating.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Operating"
77
identifier: "ops"
88
weight: 300
9-
pre: icon-database
9+
pre: database
1010
project: "riak_cs"
1111
project_version: "2.0.1"
1212
---

Diff for: ‎content/riak/cs/2.0.1/reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Reference"
77
identifier: "reference"
88
weight: 500
9-
pre: icon-references
9+
pre: references
1010
project: "riak_cs"
1111
project_version: "2.0.1"
1212
---

Diff for: ‎content/riak/cs/2.0.1/theory.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Theory & Concepts"
77
identifier: "theory"
88
weight: 400
9-
pre: icon-beaker
9+
pre: beaker
1010
project: "riak_cs"
1111
project_version: "2.0.1"
1212
---

Diff for: ‎content/riak/cs/2.1.0/cookbooks/multi-datacenter-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Riak CS Enterprise"
77
identifier: "mdc_overview"
88
weight: 600
9-
pre: icon-cloud
9+
pre: cloud
1010
project: "riak_cs"
1111
project_version: "2.1.0"
1212
aliases:

Diff for: ‎content/riak/cs/2.1.0/developing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Developing"
77
identifier: "develop"
88
weight: 200
9-
pre: icon-lambda
9+
pre: lambda
1010
project: "riak_cs"
1111
project_version: "2.1.0"
1212
---

Diff for: ‎content/riak/cs/2.1.0/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Riak CS"
77
identifier: "index"
88
weight: 100
9-
pre: icon-bolt
9+
pre: bolt
1010
project: "riak_cs"
1111
project_version: "2.1.0"
1212
aliases:

Diff for: ‎content/riak/cs/2.1.0/operating.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Operating"
77
identifier: "ops"
88
weight: 300
9-
pre: icon-database
9+
pre: database
1010
project: "riak_cs"
1111
project_version: "2.1.0"
1212
---

Diff for: ‎content/riak/cs/2.1.0/reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Reference"
77
identifier: "reference"
88
weight: 500
9-
pre: icon-references
9+
pre: references
1010
project: "riak_cs"
1111
project_version: "2.1.0"
1212
---

Diff for: ‎content/riak/cs/2.1.0/theory.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Theory & Concepts"
77
identifier: "theory"
88
weight: 400
9-
pre: icon-beaker
9+
pre: beaker
1010
project: "riak_cs"
1111
project_version: "2.1.0"
1212
---

Diff for: ‎content/riak/cs/2.1.1/cookbooks/multi-datacenter-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Riak CS Enterprise"
77
identifier: "mdc_overview"
88
weight: 600
9-
pre: icon-cloud
9+
pre: cloud
1010
project: "riak_cs"
1111
project_version: "2.1.1"
1212
aliases:

Diff for: ‎content/riak/cs/2.1.1/developing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Developing"
77
identifier: "develop"
88
weight: 200
9-
pre: icon-lambda
9+
pre: lambda
1010
project: "riak_cs"
1111
project_version: "2.1.1"
1212
---

Diff for: ‎content/riak/cs/2.1.1/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ menu:
66
name: "Riak CS"
77
identifier: "index"
88
weight: 100
9-
pre: icon-bolt
9+
pre: bolt
1010
project: "riak_cs"
1111
project_version: "2.1.1"
1212
aliases:

0 commit comments

Comments
 (0)