@hestia-earth/guide 0.0.13 → 0.0.15

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 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.15](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.14...v0.0.15) (2025-04-10)
+
+
+### Features
+
+* **applying-models:** add contribution docs ([184ffaa](https://gitlab.com/hestia-earth/hestia-guide/commit/184ffaa0582c0543cfe53589adec4e4b5401412f))
+* **community-edition:** add introduction and usage ([98361b5](https://gitlab.com/hestia-earth/hestia-guide/commit/98361b5dae3ba6b3f74bda98d0dde8cf26314ad4))
+* **hestia-101:** add shortcuts to other pages ([45d3356](https://gitlab.com/hestia-earth/hestia-guide/commit/45d3356d9d741d14d7032391eac4e46c1e0e4524))
+
+### [0.0.14](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.13...v0.0.14) (2025-04-07)
+
+
+### Features
+
+* **file-upload:** add uploading page with step-by-step ([f1fc4f0](https://gitlab.com/hestia-earth/hestia-guide/commit/f1fc4f0a12eb3d0a33821710fdd43c41d4cd90ae))
+* **index:** add `enableCitations` parameter to page ([1dda616](https://gitlab.com/hestia-earth/hestia-guide/commit/1dda6163f49ec960ea26ed2e03e5c5e44cbc2dda))
+* **index:** skip parent ids for model pages ([5083e6c](https://gitlab.com/hestia-earth/hestia-guide/commit/5083e6c40057cf3924b38555172c1097844b15f7))
+
+
+### Bug Fixes
+
+* fix header level ([fcd68f7](https://gitlab.com/hestia-earth/hestia-guide/commit/fcd68f77b492eb45ddb7d42420f639d444d61535))
+
 ### [0.0.13](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.12...v0.0.13) (2025-04-04)
 
 

package/README.md

@@ -2,11 +2,7 @@
 
 This repository contains the raw content of the guide written in Markdown language.
 
-Every file under _src/content_ will be automatically deployed to https://hestia-earth.gitlab.io/hestia-guide domain for testing.
-
-Example:
-- src/content/introduction.md will be deployed to https://hestia-earth.gitlab.io/hestia-guide/introduction
-- src/content/how-to-upload.md will be deployed to https://hestia-earth.gitlab.io/hestia-guide/how-to-upload
+Every file under _src/content_ will be automatically deployed to https://www-dev.hestia.earth/guide?branc=<branch-name> for testing.
 
 Note: only lower chars, dashes (`-`) and numbers are allowed in the filenames.
 
@@ -14,20 +10,20 @@ Note: only lower chars, dashes (`-`) and numbers are allowed in the filenames.
 
 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:
+1. Start the file with a header level 1 using `#`. Example:
     ```markdown
-    ## This is the header
+    # This is the header
 
     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 header level 1 will be automatically used as Title for the Guide page, so please try to keep it short, and do not use special characters.
 
 The second line (omitting the blank lines) will be used as abstract.
 
-*Example*: if you are adding a page called "Signing in" under "HESTIA 101", please:
+*Example*: if you are adding a page called "Signing in" under "HESTIA 101":
 - 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.
 
@@ -48,7 +44,7 @@ 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 |
 | ---- | ---- | ---- |
-| `author` | ❌ | Name of the person that wrote the file |
+| `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" |
 
@@ -59,10 +55,52 @@ These metadata must be added at the end of the file, one per line. The list of m
 
 This is the content of the page.
 
+/author ~John Doe~
 /tag ~Hestia~
 /tag ~Beginners~
 ```
 
+### Adding collapsible groups
+
+Collapsible blocks (hides the content with a toggle icon) can be added using html code as following:
+```markdown
+<div class="collapsibles">
+  <div class="collapsible-group">
+    <div class="collapsible-header">
+      <span>First collapsible header</span>
+    </div>
+    <div class="collapsible-content">First collapsible content</div>
+  </div>
+
+  <div class="collapsible-group">
+    <div class="collapsible-header">
+      <span>Second collapsible header</span>
+    </div>
+    <div class="collapsible-content">Second collapsible content</div>
+  </div>
+</div>
+```
+
+### Adding step-by-step content
+
+Step by step content (title including a step number and a content):
+```markdown
+<div class="step">
+  <div class="step--header">
+    <div>1</div>
+    <div>This is the first step</div>
+  </div>
+  <div class="step--image">
+    <img src="/assets/step-1.png" />
+  </div>
+  <div class="step--content">
+    <p>Content goes here</p>
+  </div>
+</div>
+```
+
+Note: the `steps--image` is optional.
+
 ### Adding images or videos
 
 To add an image or a video to a page:

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

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

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

@@ -1,4 +1 @@
-{
-  "tags": {},
-  "content": "## Contributing"
-}
+{"tags":{},"content":"# Contributing\n\nHESTIA models are made freely available on our [Gitlab page](https://gitlab.com/hestia-earth/hestia-engine-models).\n\nFull contribution guidelines are available [here](https://gitlab.com/hestia-earth/hestia-engine-models/-/blob/master/CONTRIBUTING.md)."}

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

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

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

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

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

@@ -1,4 +1 @@
-{
-  "tags": {},
-  "content": "## Community Edition\n\nUnderstand the features available to community users and how to make the most out of them."
-}
+{"tags":{},"content":"# Community Edition\n\nUnderstand the features available to community users and how to make the most out of them.\n\n## Introduction\n\nA simplified version of HESTIA that you can install on your own servers.\nIt provides all of our models but gives you control over when you update to newer models and control over which models you run and when (\"orchestration\").\nAll data is hosted on your own servers and you maintain data confidentiality.\nThe Community Edition comes with its own API.\n\n## Usage\n\nTo find information about the installation process, or raise issues, please visit the [Gitlab page](https://gitlab.com/hestia-earth/hestia-community-edition)."}

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

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

package/dist/content/faq/content.json

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

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

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

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

@@ -0,0 +1 @@
+{"tags":{},"content":"# Why contribute?"}

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

@@ -0,0 +1 @@
+{"tags":{},"content":"# Getting started"}

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

@@ -0,0 +1 @@
+{"tags":{},"content":"# Getting through the upload pipeline"}

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

@@ -0,0 +1 @@
+{"tags":{},"content":"# Preparing a dataset"}

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

@@ -0,0 +1 @@
+{"tags":{},"content":"# Uploading your file\n\n## Step by step to upload your file\n\n<div class=\"step\">\n  <div class=\"step--header\">\n    <div>1</div>\n    <div>Navigate to the data upload page</div>\n  </div>\n  <div class=\"step--image\">\n    <img src=\"/assets/file-upload/uploading/step-1.png\" />\n  </div>\n  <div class=\"step--content\">\n    From your dashboard, click on the Data Upload option in the left-hand navigation menu. This will take you to the file upload interface, where you can choose to add new data or update existing files.\n  </div>\n</div>\n\n<div class=\"step\">\n  <div class=\"step--header\">\n    <div>2</div>\n    <div>Select your upload type</div>\n  </div>\n  <div class=\"step--image\">\n    <img src=\"/assets/file-upload/uploading/step-2.png\" />\n  </div>\n  <div class=\"step--content\">\n    <p>Once on the Data Upload page, you’ll need to choose the type of upload.</p>\n    <ul>\n      <li>New Upload: Use this option if you’re uploading a file for the first time.</li>\n      <li>Re-Upload: Choose this if you are updating an existing file.</li>\n    </ul>\n    <p>To make your selection, simply click on the appropriate button under Upload Type.</p>\n  </div>\n</div>\n\n<div class=\"step\">\n  <div class=\"step--header\">\n    <div>3</div>\n    <div>Choose a file to upload</div>\n  </div>\n  <div class=\"step--image\">\n    <img src=\"/assets/file-upload/uploading/step-3.png\" />\n  </div>\n  <div class=\"step--content\">\n    <p>After choosing your upload type, select the file you want to upload. Make sure the file has been prepared for the platform. You can either pick a file from your previous uploads using the dropdown menu or drag and drop a new file into the upload area. Alternatively, click Browse Files to locate a file from your device.</p>\n    <p>Make sure the file:</p>\n    <ul>\n      <li>Is no larger than 100MB.</li>\n      <li>Is in one of the supported formats: .xls, .xlsx, .csv, or .json.</li>\n    </ul>\n    <p>If your file doesn’t meet these requirements, you’ll need to modify it before proceeding.</p>\n  </div>\n</div>\n\n<div class=\"step\">\n  <div class=\"step--header\">\n    <div>4</div>\n    <div>Submit your file</div>\n  </div>\n  <div class=\"step--image\">\n    <img src=\"/assets/file-upload/uploading/step-4.png\" />\n  </div>\n  <div class=\"step--content\">\n    <p>If your data is intended to remain private, ensure you use the DataPrivate field in the file to prevent public indexing.</p>\n    <p>Then select you file and ensure it meets the requirements, click Submit to start the upload. If you change your mind, you can click Cancel to exit the process without uploading.</p>\n    <p>After submitting, your data will be accessible to platform administrators and reviewers.</p>\n    <p>For more detailed information on privacy, you can visit our Privacy Policy.</p>\n  </div>\n</div>\n\n<div class=\"step\">\n  <div class=\"step--header\">\n    <div>5</div>\n    <div>Navigate to the data upload page</div>\n  </div>\n  <div class=\"step--content\">\n    <p>If you encounter any issues during the upload process or have questions, feel free to reach out to us at <a href=\"mailto:community@hestia.earth\">community@hestia.earth</a> for assistance.</p>\n  </div>\n</div>"}

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

@@ -1,4 +1 @@
-{
-  "tags": {},
-  "content": "## HESTIA 101\n\nLearn the essentials of getting started with the platform."
-}
+{"tags":{},"content":"# HESTIA 101\n\nLearn the essentials of getting started with the platform."}

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

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