Skip to content

Commit 1a58514

Browse files
author
Dennis Dawson
committed
Merge pull request #8 from kite-sdk/addingTitles
Removed _Sidebar.md (not used in Jekyll). Added titles to all pages. Min...
2 parents 2963c64 + 4a4a918 commit 1a58514

15 files changed

+28
-50
lines changed

‎Column-Mapping.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Column Mapping
34
---
45

56
## Column Mapping

‎HBase-Storage-Cells.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: HBase Storage Cells
34
---
45
## HBase Storage Cells
56

‎Inferring-a-Schema-from-a-Java-Class.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Infer a Schema from Java
34
---
45

56
## Inferring a Schema from a Java Class

‎Inferring-a-Schema-from-an-Avro-Data-File.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Infer a Schema from Avro
34
---
45
## Inferring a Schema from an Avro Data File
56

‎Kite-Data-Module-Overview.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Kite Data Overview
34
---
45

56
## Kite Data Module Overview

‎Kite-Dataset-Command-Line-Interface.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Kite CLI
34
---
45
## Kite Dataset Command Line Interface
56

‎Kite-SDK-Guide.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Kite SDK Guide
34
---
45

56
## What Is Kite, and Why Is It Awesome?

‎Parquet-vs-Avro-Format.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Parquet vs Avro
34
---
45
## Parquet versus Avro Format
56

‎Partition-Strategy-Format.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
22
layout: page
3+
title: Partition Strategy Format
34
---
45
## Partition Strategy JSON Format
56

6-
A partition strategy is made of a list of partition fields. Each field defines how to take source data from an entity and produce a value that will be used to store the entity. For example, a field may produce the year an event happened from its timestamp. Another field in the strategy may be the month from the timestamp.
7+
A partition strategy is made up of a list of partition fields. Each field defines how to take source data from an entity and produce a value that is used to store the entity. For example, a field can produce the year an event happened from its timestamp. Another field in the strategy can be the month from the timestamp.
78

8-
Partition strategies are defined in [JSON][json] format. The strategy must be a list of objects---name/value pairs---each of which define a field in the partition strategy. All field definitions require at least two attributes:
9+
Partition strategies are defined in [JSON][json] format. The strategy must be a list of objects---name/value pairs---each of which defines a field in the partition strategy. All field definitions require at least two attributes:
910

10-
* `source` -- a source field on the entity, like "created_at"
11-
* `type` -- the type of partition derived from the source data, like "year"
11+
* `source` -- a source field on the entity, such as "created_at"
12+
* `type` -- the type of partition derived from the source data, such as "year"
1213

1314
Each definition can be thought of as a function run on the entity's source to produce the partition field's data. The order of the partition fields is preserved and used when the strategy is applied.
1415

@@ -24,7 +25,7 @@ The available types are:
2425
| `identity` | any string or number | the source value, unchanged | must be a string or numeric |
2526
| `hash` | any object | int hash of the value, 0-B | requires B, `buckets` integer attribute[<sup>2</sup>](#notes) |
2627

27-
A field definition may optionally provide a `name` attribute, which is used to reference the partition field. HDFS datasets use this name when creating partition paths. If the name attribute is missing, it will be defaulted based on the partition type and source field name.
28+
A field definition can optionally provide a `name` attribute, which is used to reference the partition field. HDFS datasets use this name when creating partition paths. If the name attribute is missing, it is defaulted based on the partition type and source field name.
2829

2930
Requirements for the source data are validated when schemas and partition strategies are used together.
3031

‎Partitioned-Datasets.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Partitioned Datasets
34
---
45
## Partitioned Datasets
56

‎Schema-URL-Warning.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1+
---
2+
layout: page
3+
title: Schema URL Warning
4+
---
15
This page explains the schema URL warning:
26
> The Dataset is using a schema literal rather than a URL which will be attached to every message.
37
4-
This warning means that the Dataset has been configured using an avro schema string, schema object, or by reflection. Configuring with a HDFS URL where the schema can be found instead of the other options allows certain components to pass the schema URL rather than the schema's string literal, which cuts down on the size of headers that must be sent with each message.
8+
This warning means that the Dataset is configured using an Avro schema string, a schema object, or by reflection. Configuring with an HDFS URL where the schema can be found, instead of the other options, allows certain components to pass the schema URL rather than the schema's string literal. This cuts down on the size of headers that must be sent with each message.
59

610
### Fixing the problem
711

@@ -26,4 +30,4 @@ DatasetDescriptor newDescriptor = new DatasetDescriptor.Builder(dataset.getDescr
2630
.schemaUri(schemaPath.toUri())
2731
.build();
2832
repo.update(dataset.getName(), newDescriptor);
29-
```
33+
```

‎Using-the-Kite-CLI-to-Create-a-Dataset.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Using Kite CLI
34
---
45

56
## Using the Kite Command Line Interface to Create a Dataset

‎_Sidebar.md

-41
This file was deleted.

‎about.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: page
3-
title: About
3+
title: About Kite SDK
44
permalink: /about/
55
---
66

@@ -10,4 +10,3 @@ The Kite Software Development Kit (Apache License, Version 2.0), or Kite for sho
1010
* Lets developers focus on business logic, not plumbing or infrastructure
1111
* Provides smart defaults for platform choices
1212
* Supports gradual adoption via loosely-coupled modules
13-

‎index.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: page
3+
title: Welcome to Kite
34
---
45

56
## Welcome to the Kite Wiki!
@@ -28,3 +29,7 @@ This is the default landing page for Kite SDK documentation.
2829
* [Column Mapping](Column-Mapping/)
2930
* [HBase Storage Cells](HBase-Storage-Cells/)
3031

32+
### Miscellaneous
33+
34+
* [Schema URL Warning](Schema-URL-Warning/)
35+

0 commit comments

Comments
 (0)