Contrib.social

README.md in 2.0.x branch still talks about .json files, confusing users

Open on Drupal.org →
Created on 1 November 2023, over 1 year ago
Updated 6 September 2024, 8 months ago

Problem/Motivation

Thanks for this great module! Using it to deploy commerce related content across dev/test/prod sites. I clicked together a store, used drush dce to export it and got a 1.json file. When I tried to import that on another site, I got a deprecation warning about missing HAL + serialization:

To import hal_json files, the serialization module must be enabled. This is deprecated and will be removed in default_content:3.0.0. See https://www.drupal.org/node/3296226 →

However, upon closer inspection, the 1.json file was already in YAML format, it just had the wrong file extension. 😅 I tried with dcer and got an identical file but with a .yml extension (and a UUID for the name, not the entity ID). So this bug is specific to dce.

Steps to reproduce

  1. Read the README.md
  2. Come to the (incorrect) conclusion that you're supposed to name things {entityID}.json.
  3. Create an entity
  4. Export it with drush dce, follow the docs, and put it in content/node/1.json
  5. Try to import and get an error.
  6. Inspect the file and realize it's already in YAML format, you just gave it the wrong name due to the stale docs. 😂

Proposed resolution

Fix the README.md to talk about .yml files, not .json files.

Remaining tasks

User interface changes

API changes

Data model changes

🐛 Bug report
Status

Fixed

Version

2.0

Component

Documentation

Created by

🇺🇸United States dww

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

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024