nextcloud / nextcloud/cookbook

Meta: Future file structure

Open
#340 19 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dependent documentation enhancement question
Dominant language
HTML
Stars
641
Forks
113
Avg merge
21h 31m
Merged PRs (30d)
26

Description

Currently the files are structured in a folder of the user. In this folder, one recipe.json and max two images are located.

I suggest to extend this file/folder structure to allow for more information to be stored while keeping with the main motivation of saving all information as files for easier backup:

I suggest to add one optional file meta.json to each folder. This folder can take different options that are related to other currently open issues here (e.g. #311). The exact structure of this meta file needs to be discussed. As it is only internal to the cookbook app, we are relative free in the data to be stored there.

This issue should serve as a discussion basis.


Depends on #1126

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current per-user folder structure, including recipe.json and the limit of two images. Read the dependency in #1126 and related issue #311 before discussing the meta.json schema. Done means the stored data structure and implementation scope are agreed.

Written by the indexing model from the issue text.

Assessment

Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.