Skip to content

Commit

Permalink
Move migration guides (bevyengine#605)
Browse files Browse the repository at this point in the history
Co-authored-by: ickk <[email protected]>
  • Loading branch information
akappel and ickk authored Mar 14, 2023
1 parent b036281 commit 3143eac
Show file tree
Hide file tree
Showing 33 changed files with 199 additions and 105 deletions.
4 changes: 2 additions & 2 deletions content/learn/book/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
+++
title = "Book"
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
redirect_to = "learn/book/introduction"
insert_anchor_links = "right"
+++
4 changes: 2 additions & 2 deletions content/learn/book/contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Contributing"
weight = 4
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
[extra]
subtitle = "join the bevy"
Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/contributing/code/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Code"
weight = 1
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Contributing Code"
Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/contributing/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Docs"
weight = 2
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Contributing Docs"
Expand Down
6 changes: 3 additions & 3 deletions content/learn/book/faq/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
+++
title = "Faq"
title = "FAQ"
weight = 6
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Frequently Asked Questions"
Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Getting Started"
weight = 2
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
+++

Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/getting-started/apps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Apps"
weight = 2
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
+++

Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/getting-started/ecs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "ECS"
weight = 3
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
+++

Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/getting-started/plugins/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Plugins"
weight = 4
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
+++

Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/getting-started/resources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Resources"
weight = 5
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
+++

Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/getting-started/setup/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Setup"
weight = 1
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
+++

Expand Down
6 changes: 3 additions & 3 deletions content/learn/book/introduction/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
title = "Introduction"
weight = 1
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
+++

If you came here because you wanted to learn how to make 2D / 3D games, visualizations, user interfaces, or other graphical applications with Bevy ... you came to the right place! If not, stick around anyway. I promise it will be fun.

<h2>
<img src="/assets/whats_a_bevy.svg" class="book-whats-a-bevy" alt="What's a BEVY?"/>
<img src="/assets/whats_a_bevy.svg" class="docs-whats-a-bevy" alt="What's a BEVY?"/>
</h2>

A bevy is a group of birds!
Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/next-steps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Next Steps"
weight = 3
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
+++

Expand Down
4 changes: 2 additions & 2 deletions content/learn/book/troubleshooting/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title = "Troubleshooting"
weight = 5
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
+++

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
+++
title = "0.4 to 0.5"
weight = 1
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
weight = 7
template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Migration Guide: 0.4 to 0.5"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
+++
title = "0.5 to 0.6"
weight = 2
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
weight = 6
template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Migration Guide: 0.5 to 0.6"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
+++
title = "0.6 to 0.7"
weight = 3
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
weight = 5
template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Migration Guide: 0.6 to 0.7"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
+++
title = "0.7 to 0.8"
weight = 4
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Migration Guide: 0.7 to 0.8"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
+++
title = "0.8 to 0.9"
weight = 5
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
weight = 3
template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Migration Guide: 0.8 to 0.9"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
+++
title = "0.9 to 0.10"
weight = 6
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
weight = 2
template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Migration Guide: 0.9 to 0.10"
Expand Down
7 changes: 7 additions & 0 deletions content/learn/migration-guides/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = "Migration Guides"
sort_by = "weight"
page_template = "docs-section.html"
redirect_to = "learn/migration-guides/introduction"
insert_anchor_links = "right"
+++
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
+++
title = "Migration Guides"
weight = 7
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
title = "Introduction"
weight = 1
template = "docs-section.html"
insert_anchor_links = "right"
+++

Expand Down
4 changes: 2 additions & 2 deletions generate-release/src/migration_guide.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ pub fn generate_migration_guide(
title = "{title}"
weight = {weight}
sort_by = "weight"
template = "book-section.html"
page_template = "book-section.html"
template = "docs-section.html"
page_template = "docs-section.html"
insert_anchor_links = "right"
[extra]
long_title = "Migration Guide: {title}"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
.book-footer {
.docs-footer {
$border-color: #2f3033;

--book-footer-gap: 12px;
--docs-footer-gap: 12px;

margin: 32px 0;

@media #{$bp-tablet-portrait-up} {
--book-footer-gap: 20px;
--docs-footer-gap: 20px;
}

&__nav {
display: grid;
gap: var(--book-footer-gap);
padding: var(--book-footer-gap) 0;
gap: var(--docs-footer-gap);
padding: var(--docs-footer-gap) 0;
grid-template-columns: 1fr;
grid-template-areas:
'next'
Expand All @@ -39,7 +39,7 @@
background-color: rgba($color-white, 0.01);
color: $color-white;

.book-footer__dir {
.docs-footer__dir {
color: #999;
}
}
Expand All @@ -49,7 +49,7 @@
flex-direction: row-reverse;
padding-left: 16px;

.book-footer__label {
.docs-footer__label {
padding: 0 8px 0 12px;
}
}
Expand All @@ -59,7 +59,7 @@
text-align: right;
padding-right: 16px;

.book-footer__label {
.docs-footer__label {
padding: 0 12px 0 8px;
}
}
Expand Down Expand Up @@ -87,7 +87,7 @@
&__edit-wrapper {
border-top: 2px solid $border-color;
text-align: center;
padding-top: var(--book-footer-gap);
padding-top: var(--docs-footer-gap);
}

&__edit {
Expand Down
8 changes: 4 additions & 4 deletions sass/pages/_book.scss → sass/pages/_docs.scss
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
.book-page {
.docs-page {
display: flex;
width: 100%;
min-height: 500px;
}

.book-page-subtitle {
.docs-page-subtitle {
font-size: 1.3rem;
font-weight: 800;
color: #999999;
font-style: italic;
vertical-align: middle;
}

.book-content {
.docs-content {
position: relative;
width: 100%;
min-width: 0;
Expand All @@ -39,7 +39,7 @@
}


.book-whats-a-bevy {
.docs-whats-a-bevy {
background-color: #00000000 !important;
height: 2.4rem !important;
border-radius: unset !important;
Expand Down
4 changes: 2 additions & 2 deletions sass/site.scss
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
// - Components can be composed between them to create new components
// - These should be self contained and shouldn't affect other styling
@import "components/bevy-instance";
@import "components/book-footer";
@import "components/docs-footer";
@import "components/button-square";
@import "components/button";
@import "components/card";
Expand All @@ -47,7 +47,7 @@
@import "pages/community";
@import "pages/people";
@import "pages/assets";
@import "pages/book";
@import "pages/docs";
@import "pages/news";
@import "pages/features";
@import "pages/content";
Expand Down
Loading

0 comments on commit 3143eac

Please sign in to comment.