From d29c1e3c58680b5aace56492f1f6d9a5185cf360 Mon Sep 17 00:00:00 2001 From: Isaac Donaldson Date: Tue, 17 Sep 2024 17:05:12 -0700 Subject: [PATCH 1/2] remove fields that were preventing zola from running --- docs-site/config.toml | 2 +- docs-site/content/authors/_index.md | 2 -- docs-site/content/docs/_index.md | 2 -- docs-site/content/docs/extras/_index.md | 2 -- docs-site/content/docs/getting-started/_index.md | 2 -- docs-site/content/docs/infrastructure/_index.md | 2 -- docs-site/content/docs/processing/_index.md | 2 -- docs-site/content/docs/resources/_index.md | 2 -- docs-site/content/docs/the-app/_index.md | 2 -- docs-site/content/privacy-policy/_index.md | 2 -- 10 files changed, 1 insertion(+), 19 deletions(-) diff --git a/docs-site/config.toml b/docs-site/config.toml index 531c61105..a6e1caac7 100644 --- a/docs-site/config.toml +++ b/docs-site/config.toml @@ -8,7 +8,7 @@ description = "Loco is a productivity-first web and service framework in Rust" compile_sass = true # Whether to generate a feed file for the site -generate_feed = true +generate_feeds = true # When set to "true", the generated HTML files are minified. minify_html = false diff --git a/docs-site/content/authors/_index.md b/docs-site/content/authors/_index.md index 894026cad..d51fa5695 100644 --- a/docs-site/content/authors/_index.md +++ b/docs-site/content/authors/_index.md @@ -1,8 +1,6 @@ +++ title = "Authors" description = "The authurs of the blog articles." -date = 2021-04-01T08:00:00+00:00 -updated = 2021-04-01T08:00:00+00:00 draft = false # If add a new author page in this section, please add a new item, diff --git a/docs-site/content/docs/_index.md b/docs-site/content/docs/_index.md index 286c38485..517a4545e 100644 --- a/docs-site/content/docs/_index.md +++ b/docs-site/content/docs/_index.md @@ -1,8 +1,6 @@ +++ title = "Docs" description = "Docs for loco" -date = 2025-05-01T08:00:00+00:00 -updated = 2021-05-01T08:00:00+00:00 sort_by = "weight" weight = 1 template = "docs/section.html" diff --git a/docs-site/content/docs/extras/_index.md b/docs-site/content/docs/extras/_index.md index c11595fac..d06ff7b1e 100644 --- a/docs-site/content/docs/extras/_index.md +++ b/docs-site/content/docs/extras/_index.md @@ -1,8 +1,6 @@ +++ title = "Extras" description = "" -date = 2025-05-01T18:00:00+00:00 -updated = 2021-05-01T18:00:00+00:00 template = "docs/section.html" sort_by = "weight" weight = 5 diff --git a/docs-site/content/docs/getting-started/_index.md b/docs-site/content/docs/getting-started/_index.md index 01d773613..9c13e1c6d 100644 --- a/docs-site/content/docs/getting-started/_index.md +++ b/docs-site/content/docs/getting-started/_index.md @@ -1,8 +1,6 @@ +++ title = "Getting Started" description = "" -date = 2025-05-01T08:00:00+00:00 -updated = 2021-05-01T08:00:00+00:00 template = "docs/section.html" sort_by = "weight" weight = 1 diff --git a/docs-site/content/docs/infrastructure/_index.md b/docs-site/content/docs/infrastructure/_index.md index b666ba2a2..c187083e1 100644 --- a/docs-site/content/docs/infrastructure/_index.md +++ b/docs-site/content/docs/infrastructure/_index.md @@ -1,8 +1,6 @@ +++ title = "Infrastructure" description = "" -date = 2025-05-01T18:00:00+00:00 -updated = 2021-05-01T18:00:00+00:00 template = "docs/section.html" sort_by = "weight" weight = 4 diff --git a/docs-site/content/docs/processing/_index.md b/docs-site/content/docs/processing/_index.md index fb9bfcb64..5a8188f26 100644 --- a/docs-site/content/docs/processing/_index.md +++ b/docs-site/content/docs/processing/_index.md @@ -1,8 +1,6 @@ +++ title = "Processing" description = "" -date = 2025-05-01T18:00:00+00:00 -updated = 2021-05-01T18:00:00+00:00 template = "docs/section.html" sort_by = "weight" weight = 3 diff --git a/docs-site/content/docs/resources/_index.md b/docs-site/content/docs/resources/_index.md index ff54cf819..feb90bcf5 100644 --- a/docs-site/content/docs/resources/_index.md +++ b/docs-site/content/docs/resources/_index.md @@ -1,8 +1,6 @@ +++ title = "Resources" description = "" -date = 2025-05-01T19:00:00+00:00 -updated = 2021-05-01T19:00:00+00:00 template = "docs/section.html" sort_by = "weight" weight = 6 diff --git a/docs-site/content/docs/the-app/_index.md b/docs-site/content/docs/the-app/_index.md index aa6423e0e..e34f424c7 100644 --- a/docs-site/content/docs/the-app/_index.md +++ b/docs-site/content/docs/the-app/_index.md @@ -1,8 +1,6 @@ +++ title = "The App" description = "" -date = 2025-05-01T18:00:00+00:00 -updated = 2021-05-01T18:00:00+00:00 template = "docs/section.html" sort_by = "weight" weight = 2 diff --git a/docs-site/content/privacy-policy/_index.md b/docs-site/content/privacy-policy/_index.md index d8050da75..9863ceea6 100644 --- a/docs-site/content/privacy-policy/_index.md +++ b/docs-site/content/privacy-policy/_index.md @@ -1,8 +1,6 @@ +++ title = "Privacy Policy" description = "We do not use cookies and we do not collect any personal data." -date = 2021-05-01T08:00:00+00:00 -updated = 2020-05-01T08:00:00+00:00 draft = false [extra] From 5d14e6eb22d6807863cf26d9731a576784fbbd2d Mon Sep 17 00:00:00 2001 From: Isaac Donaldson Date: Tue, 17 Sep 2024 17:21:07 -0700 Subject: [PATCH 2/2] add mention of zola to CONTRIBUTING.md --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c40fa52a7..9115ea351 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,6 +78,11 @@ Updating the Documentation + Create the snippet in the [yaml file](./snipdoc.yml) or inline the code. + Run `snipdoc run`. +To run the documentation site locally, we use [zola](https://www.getzola.org/) so you'll need to [install](https://www.getzola.org/documentation/getting-started/installation/) it. The documentation site works with zola version `0.19.2` and since zola still has breaking changes, we make no guarantees about other versions. + +Running the local preview ++ `cd docs-site` ++ `npm run serve` or `zola serve` ## Open A Pull Request