Skip to content

Commit

Permalink
docs: add prod docs, add screenshots to tag docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pyphilia committed Jan 8, 2025
1 parent f564d74 commit 398b3e2
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 8 deletions.
16 changes: 8 additions & 8 deletions blog/2024-12-12-production-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ For the last update of the year, the Graasp team brings to you key updates and f

- Remove the "Published" badge from the item grid
- Enhance modals for File Upload, Etherpad, and App creation
- Enable deletion of pseudonymized logins and their associated guest data
- Fix crash when accessing links without a protocol
- Resolve color display issues
- Eliminate use of display names
- Enable the deletion of pseudonymized logins and their associated guest data for better data management.
- Fix the crash that occurs when accessing links without a protocol (e.g., missing "http://").
- Address and resolve color display inconsistencies across the platform.
- Eliminate use of display names for items

## Apps

- Update dependencies for climate apps and resolve height display issues

## Backend

- Implement endpoints for tag management (create and delete tags)
- Handle and process H5P files in the general file upload
- Add comprehensive documentation for member endpoints
- Resolve schema errors
- Implement endpoints for tag management, allowing users to create and delete tags efficiently.
- Add support for handling and processing H5P files within the general file upload feature.
- Provide comprehensive documentation for member endpoints to improve developer understanding and usage.
- Fix schema errors to ensure proper data validation and consistency across the system.
- Reduce the export time limit for actions

As we wrap up 2024 and step into 2025, the team wishes you a year filled with new opportunities, growth, and happiness!
Expand Down
64 changes: 64 additions & 0 deletions blog/2025-01-07-production-release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: January 7th, Updates
description: Updates to the Graasp platform
date: 2025-01-07
authors:
- graasp
---

For the first update of 2025, new features include a "new folder" button, tag-based content organization, and updated translations, alongside fixes for the Quiz app and backend improvements.

<!-- Everything below this will not be shown in the post overview -->
<!-- truncate -->

## Personalized Tags and Filters

We improved our categories system by using personalized categories, that we call tags. Those are split into 3 categories: discipline, level and resource type. You can find the tags in Builder (library page) and Library.

![library search](../docs/user/library/tags/library-search.png)
![builder tags](../docs/user/library/tags/builder-tags.png)

If your items already had tags, most of them have been migrated to this new system safely in the discipline category. Don't hesitate to tweak your tags to better fit the available categories!

[You can find detailed information about tags here](https://graasp.github.io/docs/user/library/tags/).

Below you can find our usual update breakdown for each platform:

## Builder

- **Update translations**: Update translations for Arabic, Italian, Spanish and French language.
- **Introduce a new folder button**: Add a button that allows users to create new folders for organizing their items or content.
- **Replace categories with tags**: Transition from using categories to tags for more flexible and granular content classification.

## Library

- **Implement the new tag system**: Enable the use of tags for organizing and filtering content, with resource types integrated into search to improve discoverability.

## Apps

- **Quiz**: Prevent infinite loop for readers and network errors on legacy data

## Backend

- **Enable POST and PATCH methods for item folders**: Allow the creation and updating of item folders via specific backend API endpoints.
- **Integrate tags with Meilisearch**: Replace category-based indexing with tag-based indexing in Meilisearch and perform necessary data migration.
- **Add item in app action**: Include item data in an app action on export.
- **Remove deprecated Creative Commons license values**: Remove outdated Creative Commons license options from the backend to maintain compliance and accuracy.
- **Return no content when no avatar is available**: Modify the backend to return an empty valid response when there is no avatar associated with a user.

## Client (work in progress)

- **Add landing page**: Create a new landing page for the application with small adjustments, with dedicated pages for the Terms of Service, Disclaimer, Privacy Policy and Features.
- **Add language detector**: Implement a feature to automatically detect and set the user's language preference.
- **Add preview mode**: Introduce a preview mode for users to see changes before applying them.
- **UI: Add Storybook**: Integrate Storybook for building and testing UI components in isolation.
- **Enhance login and registration forms**: Add new form headers and integrate `react-hook-form` for handling validation.
- **Resolve integration and authentication issues**: Fix client-side authentication, proxy configuration, and integration-related problems.
- **Fix reCAPTCHA issues**: Add reCAPTCHA environment variables, move reCAPTCHA to the auth layout, and fix script loading in HTML.
- **Optimize CI and deployment setup**: Implement permissions in CI, update build scripts, and adjust deployments to follow proper installation steps.

As we step into 2025, the team wishes you a year filled with new opportunities, growth, and happiness!

<!-- Generic message -->

We warmly welcome and encourage feedback from our users to continuously improve our platform. You can contact us by email [[email protected]](mailto:[email protected]) or by submitting an issue in this [Github repository](https://github.com/graasp/graasp-feedback).
Binary file added docs/user/library/tags/builder-tags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/user/library/tags/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,16 @@ For a finer categorization of tags and search filter, Graasp provides different
- **Level**: Set of tags to classify educational content according to the learner’s stage or proficiency, like _"elementary"_, _"high school"_ or _"undergraduate"_.
- **Resource Type**: Set of tags to categorize content based on the format or medium in which it is delivered, like _"article"_, _"video"_, _"lecture"_, _"quiz"_ or _"eBook"_.

![library search](./library-search.png)

## Best Practices for Manual Tagging

You can add and remove tags in the Library page of your item in Builder (find this icon <svg viewBox="0 0 1080 1080" class="mui-dir-ltr-dnhbnu" width="30px"><g class="mui-dir-ltr-wyq8fb"><circle fill="#ddd" cx="540" cy="540" r="540"></circle><path d="M368.54,261.87h-106.6c-12.21,0-22.15,9.94-22.15,22.15v503.58c0,12.22,9.94,22.15,22.15,22.15h106.6c12.21,0,22.15-9.94,22.15-22.15V284.02c0-12.21-9.94-22.15-22.15-22.15Zm-22.15,44.3v459.28h-62.3V306.17h62.3Z"></path><path d="M548.76,261.87h-106.6c-12.22,0-22.15,9.94-22.15,22.15v503.58c0,12.22,9.94,22.15,22.15,22.15h106.6c12.21,0,22.15-9.94,22.15-22.15V284.02c0-12.21-9.94-22.15-22.15-22.15Zm-84.45,503.58V306.17h62.3v459.28h-62.3Z"></path><path d="M919.72,741.33l-187.72-467.29c-2.21-5.49-6.42-9.8-11.86-12.12-5.44-2.32-11.46-2.39-16.95-.18l-98.92,39.74c-5.49,2.21-9.79,6.42-12.12,11.86s-2.39,11.46-.18,16.95l187.72,467.29c2.21,5.49,6.42,9.79,11.86,12.11,2.76,1.18,5.69,1.78,8.7,1.78,2.84,0,5.62-.54,8.26-1.6l98.92-39.74c5.49-2.21,9.79-6.42,12.12-11.86,2.32-5.44,2.39-11.46,.18-16.95Zm-49.36-4.04l-57.81,23.22-171.21-426.18,57.81-23.22,171.21,426.18Z"></path></g><g id="SVGRepo_iconCarrier" transform="translate(-14.742 50.121)"><path transform="matrix(9,0,0,9,550,550)" d="m56.74 20.89-1-2.31c3.33-7.53 3.11-7.75 2.46-8.41l-4.2-4.17-0.42-0.35h-0.49c-0.26 0-1 0-7.51 2.93l-2.38-1c-3.11-7.58-3.43-7.58-4.33-7.58h-6c-0.9 0-1.25 0-4.1 7.66l-2.37 1c-4.4-1.88-6.95-2.82-7.65-2.82h-0.56l-4.58 4.49c-0.7 0.65-0.94 0.88 2.58 8.3l-1 2.3c-7.79 3-7.79 3.3-7.79 4.23v5.89c0 0.92 0 1.25 7.82 4l1 2.29c-3.33 7.53-3.11 7.76-2.46 8.41l4.24 4.25 0.42 0.37h0.5c0.25 0 1 0 7.5-3l2.38 1c3.1 7.63 3.41 7.63 4.32 7.63h6c0.92 0 1.25 0 4.11-7.66l2.39-1c4.37 1.85 6.93 2.79 7.61 2.79h0.57l4.62-4.52c0.66-0.66 0.89-0.89-2.62-8.28l1-2.3c7.81-3 7.81-3.33 7.81-4.23v-5.87c-0.04-0.93-0.04-1.25-7.87-4.04zm-20.74 16.91a9.8 9.8 0 1 1 10-9.8 9.91 9.91 0 0 1-10 9.8z" fill="#777" stroke="#fff" stroke-width="5"></path></g></svg>)

To get the most out of your tags, here are a few simple tips:

- **Be Specific**: The more specific the tag, the easier it is for someone to find exactly what they’re looking for. For example, instead of just tagging a resource with _"physics"_ tag it with more specific terms like _"centrifugal force"_.

- **Use Consistent Tags**: Stick to a consistent set of tags across your content. This helps keep everything organized and makes it easier for both users and search engines to find related content.

![builder add tags](./builder-tags.png)
Binary file added docs/user/library/tags/library-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 398b3e2

Please sign in to comment.