Feat: nested collections

[erezrokah]

Fixes #3227
Initial support for having a folder structure in the CMS and moving entries.

Used GitLab handbook as a reference.

Example config:

backend:
  name: gitlab
  repo: erezrokah/www-gitlab-com

publish_mode: editorial_workflow
media_folder: static/media
public_folder: /media
collections:
  - name: pages
    label: Pages
    label_singular: 'Page'
    folder: source/handbook
    create: true
    nested: { depth: 100 } # accepts an optional summary template
    fields:
      - label: Title
        name: title
        widget: string
      - label: Body
        name: body
        widget: markdown
    meta: { path: { widget: string, label: 'Path', index_file: 'index' } }

Example UI:

Assumptions

• Each entry is designated by a folder with an index file specified by index_file
• The Path input controls the directory of the entry (filename cannot be modified)
• Changing an entry's directory, moves the entry's children to the new location.

Notes

• Moved the code that handles unpublished entries to backend.js from the individual backends, so we can identify which content file to read based on the extension. This should also make it easier to handle multiple content files (e.g. multi language files).

TODO

• Write docs
• Add validation (e.g. path is a valid directory, error when overwriting an existing path)
• Fix e2e tests
• Test search functionality

[erquhart]

This is looking great Erez, just some quick feedback:

• Each entry should only show in one place, probably only when its parent is selected in the collection pane. Currently an entry with children shows when that entry is selected in the collection pane, and also when its parent is selected in the collection pane.

• Changing the path field isn't causing the path to actually change in the deploy preview - I'm guessing this just hasn't been added to the test backend, but wanted to raise it in case there was any gap in requirements.

[erezrokah]

The preview was an oversight on my behalf and it is now fixed.
As for the first bullet, I made the relevant changes so it would only show an entry when a parent is selected, expect when selecting the collection itself where it still shows the root entry.

[erezrokah]

similar to editorial workflow, we need to re-load all entries after publish and navigate to the new slug if it had changed

[reimertz]

Congrats on merging this @erezrokah, Amazing work!

[simrspersahabatan]

I just tested with docusaurus v2 ... but i'm failed to show nested file. I do like your direction. I have no idea.

[simrspersahabatan]

Okay,this my detail

backend:
  name: github
  branch: main # Branch to update (optional; defaults to master)
  repo: organization/repo
  base_url: vercel.app
  auth_endpoint: api/auth

media_folder: "static/img"
collections:
  - name: docs
    label: Docs
    label_singular: 'Doc'
    folder: 'docs'
    path: '{{title}}/{{id}}'
    slug: '{{id}}'
    create: true
    nested: { depth: 100 } # accepts an optional summary template
    fields:
      - { label: "Judul", name: "title", widget: "string" }
      - {
          label: "Posisi",
          name: "sidebar_position",
          widget: "string",
          required: false,
        }
      - { label: "Keterangan", name: "body", widget: "markdown" }
    allow_nesting: true
    meta: { path: { widget: string, label: 'Path', index_file: 'index' } }

[erezrokah]

Hi @simrspersahabatan, can you open a new issue for this and use the issue template.

That will make it easier to collect all the relevant information regarding the problem you're experiencing