@hestia-earth/guide 0.0.10 → 0.0.12

package/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.12](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.11...v0.0.12) (2025-04-04)
+
+
+### Features
+
+* add all pages and abstract ([1bd6ba0](https://gitlab.com/hestia-earth/hestia-guide/commit/1bd6ba00d1e58dd97be1ce89100752fe269f831e))
+
+
+### Bug Fixes
+
+* **build-index:** handle pages with no content ([cb5e51c](https://gitlab.com/hestia-earth/hestia-guide/commit/cb5e51c11497b4fe66f317117339b3958679806c))
+
+### [0.0.11](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.10...v0.0.11) (2025-04-03)
+
+
+### Features
+
+* automatically include markdown files from models added to TOC ([a44d6ee](https://gitlab.com/hestia-earth/hestia-guide/commit/a44d6ee7c3625bd4c13c3594091fe9e5873665da))
+* include all models ([d712874](https://gitlab.com/hestia-earth/hestia-guide/commit/d71287420722f22c7c54c64176d6b11c4225c128))
+* **models:** nest models under their folder ([8760fb1](https://gitlab.com/hestia-earth/hestia-guide/commit/8760fb15f32b51e7306c44c7836dcf6071654a34))
+
+
+### Bug Fixes
+
+* remove incorrect entries in models ([3acd812](https://gitlab.com/hestia-earth/hestia-guide/commit/3acd8125130965f8c5623cc09e2f385a3bd16b13))
+
 ### [0.0.10](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.9...v0.0.10) (2024-10-30)
 
 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2024 Harmonised Environmental Storage and Tracking of the Impacts of Agriculture (HESTIA) Project
+Copyright (c) 2019-2025 Harmonised Environmental Storage and Tracking of the Impacts of Agriculture (HESTIA) Project
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -13,25 +13,27 @@ Note: only lower chars, dashes (`-`) and numbers are allowed in the filenames.
 ## Writing Guidelines
 
 1. Create a new file under `src/content` and make sure the filename only uses lowercase letters, numbers and dashes.
+1. Add the file to the `src/index.yaml` file, defining the structure of the menu.
 1. Start the file with a header level 2 using a double `##`. Example:
+    ```markdown
+    ## This is the header
 
-```markdown
-## This is the header
-
-This is the content.
+    This is the content.
 
-### This is a sub-header
-```
+    ### This is a sub-header
+    ``
 
 The header level 1 will be automatically used as Title for the Guide page, so please try to keep it short.
 
 The second line (omitting the blank lines) will be used as abstract.
 
-**Important**: the folder and the file name should reflect the Guide navigation structure.
+*Example*: if you are adding a page called "Signing in" under "HESTIA 101", please:
+- add `src/content/hestia-101/signin.md` file;
+- add a new entry `- id: signin` under the `pages` array for `hestia-101` in `src/index.yaml` file.
 
-Example: if you are adding a page called "Signing in" under "HESTIA 101", please add `src/content/hestia-101/3_signin.md` file. This will automatically:
+This will automatically:
 - show the page under "HESTIA 101" menu
-- show the page as item number 3 in the menu (if there are 2 pages before number `1_`, `2_` in the same folder)
+- show the page as item number N in the menu (depending on the page index in the yaml file)
 - match the page with the url `hestia-101-signin`
 - the title of the page will be used also in the menu
 
@@ -46,8 +48,8 @@ These metadata must be added at the end of the file, one per line. The list of m
 
 | Name | Can be added multiple times | Description |
 | ---- | ---- | ---- |
-| `previous` | ❌ | Link to the previous guide page (will show at the bottom) |
-| `next` | ❌ | Link to the next guide page (will show at the bottom) |
+| `author` | ❌ | Name of the person that wrote the file |
+| `contributor` | ✅ | Name of the person that contributed to write the file |
 | `tag` | ✅ | Used to group pages together as "related" |
 
 **Example:**
@@ -59,8 +61,6 @@ This is the content of the page.
 
 /tag ~Hestia~
 /tag ~Beginners~
-/previous ~how-to-upload~
-/next ~how-to-access-data~
 ```
 
 ### Adding images or videos
@@ -68,14 +68,7 @@ This is the content of the page.
 To add an image or a video to a page:
 - add the file under the `src/assets` folder. Note: you can use sub-directories to organise the files.
 - make sure to use a simple name, without special characters. So only letters and numbers, dashes or underscores.
-- in the content of the page, use either
-  ```html
-  <img src="/guide-content/assets/<path to the file>" alt="Text to describe the image" height="auto">
-  ```
-  or to use videos in different formats
-  ```html
-  <video width="320" height="240" controls>
-    <source src="/guide-content/assets/<path to the file>.mp4" type="video/mp4">
-    <source src="/guide-content/assets/<path to the file>.ogg" type="video/ogg">
-  </video>
-  ```
+- in the content of the page, use:
+```markdown
+![Text to describe the image](/assets/<path_to_the_file.png|.mpg>)
+```

package/dist/content/applying-models/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Applying Models\n\nLearn how to implement and run various data models for advanced analysis."
+}

package/dist/content/applying-models/contributing.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Contributing"
+}

package/dist/content/{models → applying-models}/faq.json

@@ -1,3 +1,4 @@
 {
+  "tags": {},
   "content": "## FAQ"
 }

package/dist/content/applying-models/introduction.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Introduction"
+}

package/dist/content/community-edition/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Community Edition\n\nUnderstand the features available to community users and how to make the most out of them."
+}

package/dist/content/data-explorer/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Using the Data Explorer\n\nExplore and visualize your data efficiently with our integrated tools."
+}

package/dist/content/faq/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## FAQs\n\nThe most common questions about out platform and their answers."
+}

package/dist/content/file-upload/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Uploading data\n\nStep-by-step instructions on how to securely upload your datasets to the platform."
+}

package/dist/content/hestia-101/content.json

@@ -1,3 +1,4 @@
 {
+  "tags": {},
   "content": "## HESTIA 101"
 }

package/dist/content/hestia-api/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Using the API\n\nA guide for developers looking to integrate and automate workflows with our platform’s API."
+}