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

Layout docs #497

Merged
merged 3 commits into from
Oct 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/configure/layouts/detail-highlight.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Detail Highlight
layout: DetailTechnical
description: Detail Highlight layout example
---

# Layout: Detail Highlight

Initialize with `layout: DetailHighlight` in your page's frontmatter.

This layout is used to promote, share insights, and statistics for a line of business.

This layout should be used for pages with only one level of nesting, therefore, pagination is not eligible for this
layout.

## Page geometry

<p>
<svg viewBox="0 0 200 260" width="200">
<rect fill="none" height="258" stroke="#4c505b" strokeWidth="2" width="198" x="1" y="1" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="6" />
<rect fill="none" height="180" stroke="#ea7319" strokeWidth="2" width="96" x="52" y="48" />
<rect fill="none" height="180" stroke="#ea7319" strokeWidth="2" width="40" x="154" y="48" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="234" />
</svg>
</p>
93 changes: 93 additions & 0 deletions docs/configure/layouts/detail-overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: Detail Overview
layout: DetailTechnical
description: Detail Overview layout example
---

# Layout: Detail Overview

Initialize with `layout: DetailOverview` in your page's frontmatter.

This layout is used to present an overview of expected documentation, statisitics, and ability to
navigate to more documents.

Avoid making this page too long. If it gets too long, we recommend the [Detail Technical](./detail-technical) template.

## Page geometry

<p>
<svg viewBox="0 0 200 260" width="200">
<rect fill="none" height="258" stroke="#4c505b" strokeWidth="2" width="198" x="1" y="1" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="6" />
<rect fill="none" height="180" stroke="#ea7319" strokeWidth="2" width="40" x="6" y="48" />
<rect fill="none" height="180" stroke="#ea7319" strokeWidth="2" width="96" x="52" y="48" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="234" />
</svg>
</p>

## Other Layouts

- [Detail Highlight](/developer/site/style-guide/layouts/detail-highlight)
- [Detail Technical](/developer/site/style-guide/layouts/detail-technical)
- [Landing](/developer/site/style-guide/layouts/landing)
- [Product Discover](/developer/site/style-guide/layouts/product-discover)
- [Product Preview](/developer/site/style-guide/layouts/product-preview)

---

## Filler content

Eiusmod veniam adipisicing est magna id sunt occaecat minim adipisicing ad do pariatur id aliqua.
Officia officia deserunt consequat ullamco irure. Excepteur deserunt esse occaecat ex aute. Duis do
do in incididunt cupidatat dolore veniam magna aliquip voluptate laborum. Non irure magna amet
ullamco culpa esse dolore nostrud. Id ea id ipsum incididunt do velit aliquip fugiat do non
consequat.

## A sub heading

Deserunt sunt pariatur mollit dolor eiusmod. Anim sunt officia cillum anim. Laborum ullamco
consectetur elit dolore quis laborum. Eiusmod cillum amet veniam sunt Lorem reprehenderit commodo.
Cupidatat cillum ea consequat anim. Duis voluptate nulla veniam labore quis tempor.

Commodo reprehenderit excepteur amet aliquip cillum veniam ad. Ullamco proident deserunt laboris
duis laborum consequat laboris est eu enim nulla. Mollit velit consectetur ea aliqua consectetur
mollit eu ex deserunt. Aute excepteur exercitation esse proident excepteur Lorem. Quis cillum
occaecat sint voluptate incididunt ea ipsum incididunt duis sint magna magna fugiat.

### Third-level heading

Ea do magna aute proident nulla cupidatat esse consectetur anim eu esse. Consectetur est voluptate
excepteur non dolore consequat fugiat deserunt. Est nostrud est ea irure reprehenderit commodo
nostrud nulla tempor ipsum tempor sit id exercitation. Sunt reprehenderit officia anim id quis
pariatur velit cillum incididunt officia sunt. Ullamco ipsum cillum minim deserunt eiusmod nostrud
irure et nulla laborum ipsum ipsum incididunt. Voluptate reprehenderit in occaecat ipsum nulla
excepteur excepteur mollit laboris id ad laborum do. Qui in laborum nostrud quis occaecat proident
ipsum tempor laborum consequat id ut velit occaecat.Aliquip quis qui ullamco ipsum exercitation
exercitation excepteur ea ex. Proident elit incididunt incididunt ad adipisicing quis deserunt sint
laboris deserunt ipsum culpa est. Id do ex duis Lorem exercitation amet reprehenderit. Voluptate qui
tempor qui sit minim sit qui ea id dolor excepteur. Laborum elit excepteur enim sunt consequat
officia cillum. Do ea occaecat ut voluptate ea proident duis minim ad pariatur dolore magna enim
duis. Sit aliqua aliqua ea mollit enim cupidatat proident incididunt. Eu dolore sit non incididunt.
Mollit reprehenderit sunt sunt cillum labore velit exercitation officia aliqua ea adipisicing do ea.
Commodo et fugiat velit dolore consectetur.

Amet dolore deserunt in ut amet officia exercitation sint excepteur voluptate proident tempor enim
est. Culpa proident tempor in voluptate laboris sunt consectetur sit cillum excepteur culpa enim
velit laboris. Pariatur elit amet nostrud tempor nostrud ea. Exercitation do aliquip nisi amet id.
Lorem labore incididunt sit sit veniam tempor do consectetur do culpa qui.

## Id sint deserunt laborum mollit id excepteur

mollit excepteur labore labore dolor. Sit cupidatat nostrud ad consequat amet excepteur id sunt
labore adipisicing non irure. Fugiat exercitation laborum officia minim duis dolor do officia Lorem
cillum excepteur. Sint elit mollit duis sit ad commodo.

## Cillum amet irure ut tempor tempor culpa dolore sint.

Lorem qui ipsum reprehenderit est incididunt duis exercitation ea duis fugiat. Consectetur enim id
sunt exercitation et dolore ea proident sunt excepteur fugiat dolor. Veniam proident dolore irure
incididunt deserunt pariatur quis. Incididunt ea elit deserunt occaecat eiusmod velit fugiat eiusmod
dolor eiusmod ullamco. Fugiat fugiat eiusmod occaecat nulla consequat pariatur.

Aliquip non cupidatat irure magna et fugiat sunt amet ex est excepteur irure quis. Non culpa magna
nisi enim eu nulla esse laborum amet ipsum. Eu consectetur labore do id occaecat adipisicing.
96 changes: 96 additions & 0 deletions docs/configure/layouts/detail-technical.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
title: Detail Technical
layout: DetailTechnical
description: Detail Technical layout example
---

# Layout: Detail Technical

Initialize with `layout: DetailTechnical` in your page's frontmatter.

This layout is used for longer, technical, detailed content about the product.

This layout shows less marketing-type visuals and more visual of diagrams, screenshots, and code
snippets.

This page can be short or very lengthy.

## Page geometry

<p>
<svg viewBox="0 0 200 260" width="200">
<rect fill="none" height="258" stroke="#4c505b" strokeWidth="2" width="198" x="1" y="1" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="6" />
<rect fill="none" height="180" stroke="#ea7319" strokeWidth="2" width="40" x="6" y="48" />
<rect fill="none" height="180" stroke="#ea7319" strokeWidth="2" width="96" x="52" y="48" />
<rect fill="none" height="180" stroke="#ea7319" strokeWidth="2" width="40" x="154" y="48" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="234" />
</svg>
</p>

## Other Layouts

- [Detail Highlight](/developer/site/style-guide/layouts/detail-highlight)
- [Detail Overview](/developer/site/style-guide/layouts/detail-overview)
- [Landing](/developer/site/style-guide/layouts/landing)
- [Product Discover](/developer/site/style-guide/layouts/product-discover)
- [Product Preview](/developer/site/style-guide/layouts/product-preview)

---

## Filler content

Eiusmod veniam adipisicing est magna id sunt occaecat minim adipisicing ad do pariatur id aliqua.
Officia officia deserunt consequat ullamco irure. Excepteur deserunt esse occaecat ex aute. Duis do
do in incididunt cupidatat dolore veniam magna aliquip voluptate laborum. Non irure magna amet
ullamco culpa esse dolore nostrud. Id ea id ipsum incididunt do velit aliquip fugiat do non
consequat.

## A sub heading

Deserunt sunt pariatur mollit dolor eiusmod. Anim sunt officia cillum anim. Laborum ullamco
consectetur elit dolore quis laborum. Eiusmod cillum amet veniam sunt Lorem reprehenderit commodo.
Cupidatat cillum ea consequat anim. Duis voluptate nulla veniam labore quis tempor.

Commodo reprehenderit excepteur amet aliquip cillum veniam ad. Ullamco proident deserunt laboris
duis laborum consequat laboris est eu enim nulla. Mollit velit consectetur ea aliqua consectetur
mollit eu ex deserunt. Aute excepteur exercitation esse proident excepteur Lorem. Quis cillum
occaecat sint voluptate incididunt ea ipsum incididunt duis sint magna magna fugiat.

### Third-level heading

Ea do magna aute proident nulla cupidatat esse consectetur anim eu esse. Consectetur est voluptate
excepteur non dolore consequat fugiat deserunt. Est nostrud est ea irure reprehenderit commodo
nostrud nulla tempor ipsum tempor sit id exercitation. Sunt reprehenderit officia anim id quis
pariatur velit cillum incididunt officia sunt. Ullamco ipsum cillum minim deserunt eiusmod nostrud
irure et nulla laborum ipsum ipsum incididunt. Voluptate reprehenderit in occaecat ipsum nulla
excepteur excepteur mollit laboris id ad laborum do. Qui in laborum nostrud quis occaecat proident
ipsum tempor laborum consequat id ut velit occaecat.Aliquip quis qui ullamco ipsum exercitation
exercitation excepteur ea ex. Proident elit incididunt incididunt ad adipisicing quis deserunt sint
laboris deserunt ipsum culpa est. Id do ex duis Lorem exercitation amet reprehenderit. Voluptate qui
tempor qui sit minim sit qui ea id dolor excepteur. Laborum elit excepteur enim sunt consequat
officia cillum. Do ea occaecat ut voluptate ea proident duis minim ad pariatur dolore magna enim
duis. Sit aliqua aliqua ea mollit enim cupidatat proident incididunt. Eu dolore sit non incididunt.
Mollit reprehenderit sunt sunt cillum labore velit exercitation officia aliqua ea adipisicing do ea.
Commodo et fugiat velit dolore consectetur.

Amet dolore deserunt in ut amet officia exercitation sint excepteur voluptate proident tempor enim
est. Culpa proident tempor in voluptate laboris sunt consectetur sit cillum excepteur culpa enim
velit laboris. Pariatur elit amet nostrud tempor nostrud ea. Exercitation do aliquip nisi amet id.
Lorem labore incididunt sit sit veniam tempor do consectetur do culpa qui.

## Id sint deserunt laborum mollit id excepteur

mollit excepteur labore labore dolor. Sit cupidatat nostrud ad consequat amet excepteur id sunt
labore adipisicing non irure. Fugiat exercitation laborum officia minim duis dolor do officia Lorem
cillum excepteur. Sint elit mollit duis sit ad commodo.

## Cillum amet irure ut tempor tempor culpa dolore sint.

Lorem qui ipsum reprehenderit est incididunt duis exercitation ea duis fugiat. Consectetur enim id
sunt exercitation et dolore ea proident sunt excepteur fugiat dolor. Veniam proident dolore irure
incididunt deserunt pariatur quis. Incididunt ea elit deserunt occaecat eiusmod velit fugiat eiusmod
dolor eiusmod ullamco. Fugiat fugiat eiusmod occaecat nulla consequat pariatur.

Aliquip non cupidatat irure magna et fugiat sunt amet ex est excepteur irure quis. Non culpa magna
nisi enim eu nulla esse laborum amet ipsum. Eu consectetur labore do id occaecat adipisicing.
30 changes: 30 additions & 0 deletions docs/configure/layouts/landing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Landing Layout
layout: DetailTechnical
description: Landing layout example
---

# Layout: Landing

Initialize with `layout: Landing` in your page's frontmatter.

Use this layout as a landing page to show large branded visuals, and high-level content about the
line of business.

Set the tone and voice for your LOB’s experience.

Use components that support your content with places to insert visuals, share any stats or an
introduction of LOB’s story.

Use heading styles to show the grouping of content of a section.

## Page geometry

<p>
<svg viewBox="0 0 200 260" width="200">
<rect fill="none" height="258" stroke="#4c505b" strokeWidth="2" width="198" x="1" y="1" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="6" />
<rect fill="none" height="196" stroke="#ea7319" strokeWidth="2" width="188" x="6" y="32" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="234" />
</svg>
</p>
25 changes: 25 additions & 0 deletions docs/configure/layouts/product-discover.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Product Discover Layout
layout: DetailTechnical
description: Product Discover layout
---

# Layout: Product Discover

Initialize with `layout: ProductDiscover` in your page's frontmatter.

Use this layout to introduce a product feature with a description and large visual.

This layout is use for marketing and discovery content.

## Page geometry

<p>
<svg viewBox="0 0 200 260" width="200">
<rect fill="none" height="258" stroke="#4c505b" strokeWidth="2" width="198" x="1" y="1" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="6" />
<rect fill="none" height="12" stroke="#ea7319" strokeWidth="2" width="188" x="6" y="48" />
<rect fill="none" height="162" stroke="#ea7319" strokeWidth="2" width="188" x="6" y="66" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="234" />
</svg>
</p>
24 changes: 24 additions & 0 deletions docs/configure/layouts/product-preview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Product Preview Layout
layout: DetailTechnical
description: Product Preview layout
---

# Layout: Product Preview

Initialize with `layout: ProductPreview` in your page's frontmatter.

This layout has been used to introduce a product and showcase their suite of product offerings.

Use heading styles to show the grouping of content of a section.

## Page geometry

<p>
<svg viewBox="0 0 200 260" width="200">
<rect fill="none" height="258" stroke="#4c505b" strokeWidth="2" width="198" x="1" y="1" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="6" />
<rect fill="none" height="180" stroke="#ea7319" strokeWidth="2" width="188" x="6" y="48" />
<rect fill="none" height="20" stroke="#4c505b" strokeWidth="2" width="188" x="6" y="234" />
</svg>
</p>
2 changes: 1 addition & 1 deletion docs/configure/sources/schedules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar:

# {meta.title}

A source schedule defines how often a source initiates a content pull and what to do when their is a failure.
A source schedule defines how often a source initiates a content pull and what to do when there is a failure.

A schedule can be specified for each source in the source definition, but should a source not provide a schedule it will inherit the "global" schedule.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,49 @@ sidebarData:
data:
level: 3
link: /mosaic/configure/layouts/index
childNodes: []
childNodes:
- id: /mosaic/configure/layouts/detail-highlight
fullPath: /mosaic/configure/layouts/detail-highlight.mdx
name: Detail Highlight
data:
level: 3
link: /mosaic/configure/layouts/detail-highlight
childNodes: []
- id: /mosaic/configure/layouts/detail-overview
fullPath: /mosaic/configure/layouts/detail-overview.mdx
name: Detail Overview
data:
level: 3
link: /mosaic/configure/layouts/detail-overview
childNodes: []
- id: /mosaic/configure/layouts/detail-technical
fullPath: /mosaic/configure/layouts/detail-technical.mdx
name: Detail Technical
data:
level: 3
link: /mosaic/configure/layouts/detail-technical
childNodes: []
- id: /mosaic/configure/layouts/landing
fullPath: /mosaic/configure/layouts/landing.mdx
name: Landing Layout
data:
level: 3
link: /mosaic/configure/layouts/landing
childNodes: []
- id: /mosaic/configure/layouts/product-discover
fullPath: /mosaic/configure/layouts/product-discover.mdx
name: Product Discover Layout
data:
level: 3
link: /mosaic/configure/layouts/product-discover
childNodes: []
- id: /mosaic/configure/layouts/product-preview
fullPath: /mosaic/configure/layouts/product-preview.mdx
name: Product Preview Layout
data:
level: 3
link: /mosaic/configure/layouts/product-preview
childNodes: []
- id: /mosaic/configure/plugins/index
fullPath: /mosaic/configure/plugins/index.mdx
name: Plugins
Expand Down
Loading
Loading