Contrib.social

Update README.md Composer steps, and format to Markdown

Open on Drupal.org →
Created on 10 April 2023, about 1 year ago
Updated 19 June 2024, 9 days ago

Cool module, thanks for maintaining it!

Problem/Motivation

The README.md at https://git.drupalcode.org/project/ace_editor is outdated, and doesn't work with Drupal 10.

Most importantly, the method to update the composer.json file to allow downloading the module doesn't work, and needs to be updated.

Steps to reproduce

Try to download the module to Drupal 10 by following the steps under "Installation" on https://git.drupalcode.org/project/ace_editor/-/blob/2.0.x/README.txt, and fail

Proposed resolution

Update the "Installation" section, based on the working method seen in #3331798-6: Release ACE Code Editor 2.0.0-alpha1 to work with Drupal 10 → . Also, let's use Markdown, since that is now the recommended format:

## Installation

Define npm-asset repository in the composer.json file, to allow downloading the ACE Editor JavaScript library to the correct folder:

```
composer config repositories.assets composer https://asset-packagist.org
composer config --json extra.installer-types '["npm-asset", "bower-asset"]'
composer config --json extra.installer-paths.web\/libraries\/ace '["npm-asset/ace-builds"]'
composer config --unset extra.installer-paths.web\/libraries\/\{\$name\}
composer config --json extra.installer-paths.web\/libraries\/\{\$name\} '["type:drupal-library", "type:bower-asset", "type:npm-asset"]'
```

Download the ACE Editor module and install it:

```
composer require drupal/ace_editor:2.0.x-dev
drush in ace_editor
```

Proposed resolution

  1. Add a README.md file
  2. Update README.md format to Markdown, using README.md template → .
  3. Change default branch to 2.0.x on https://git.drupalcode.org/project/ace_editor/

Installation
Install with Composer (recommended) or manually, by following these steps.

Install with Composer
Define npm-asset repository in the composer.json file, to allow downloading the ACE Editor JavaScript library to the correct folder:

composer config repositories.assets composer https://asset-packagist.org
composer config --json extra.installer-types '["npm-asset", "bower-asset"]'
composer config --json extra.installer-paths.web\/libraries\/ace '["npm-asset/ace-builds"]'
composer config --unset extra.installer-paths.web\/libraries\/\{\$name\}
composer config --json extra.installer-paths.web\/libraries\/\{\$name\} '["type:drupal-library", "type:bower-asset", "type:npm-asset"]'

Download the ACE Editor module and install it:

composer require drupal/ace_editor:~2.0
drush en ace_editor

Remaining tasks

  • ✅ File an issue
  • ✅ Addition/Change/Update/Fix
  • ✅ Testing to ensure no regression
  • ➖ Automated unit testing coverage
  • ➖ Automated functional testing coverage
  • ➖ UX/UI designer responsibilities
  • ✅ Readability
  • ➖ Accessibility
  • ➖ Performance
  • ➖ Security
  • ✅ Documentation
  • ✅ Code review by maintainers
  • ✅ Full testing and approval
  • ✅ Credit contributors
  • ✅ Review with the product owner
  • ✅ Release notes snippet
  • ✅ Release ace_editor-2.0.0 →

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

📌 Task
Status

Fixed

Version

2.0

Component

Documentation

Created by

🇩🇰Denmark ressa Copenhagen

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.69.0 2024