Document data and file workflow

Created on 13 June 2024, 5 months ago

Problem/Motivation

The current documentation doesn't explain how the module does what it does, making it difficult to assess for a non-coder.

Steps to reproduce

Proposed resolution

Add a paragraph to the module description to document the way the module works : pull a zip from Shrthand, expand it locally, copy the html to a Drupal node, and store the css, js and images on the Drupal filesystem to support the html in the node created.
Currently the only way to understand this is to read the module's code, which not everyone is able to do.
Example :
"Handling of Zip Files and Contents by the Shorthand module

The Shorthand module processes zip files containing Shorthand stories by extracting them to the server. Post-extraction, the HTML is used to create a Drupal story, while CSS, JS, and image files are moved to a designated directory. The original zip file is deleted after extraction. The module retains the extracted assets (CSS, JS, images) in the file system to ensure the Drupal story displays as intended. These files are essential for rendering the story with correct styling and functionality."

Remaining tasks

- verify the above description is factually correct, as I may be wrong in my understanding of the module's inner working
- add the description to the module's documentation

User interface changes

API changes

Data model changes

📌 Task
Status

Active

Version

4.0

Component

Documentation

Created by

🇧🇪Belgium ehanuise

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024