Create a README.md

Created on 12 February 2024, 5 months ago
Updated 20 February 2024, 4 months ago

Hello again

Problem/Motivation

I have to look into the module to know which comad to use :)
So I would like to collaborate to make the README.md

I have copied from other module and here is a proposal

# Config import single

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Use

INTRODUCTION
------------

Module to integrate the config:import:single comand from drupal console into drush

2.0.x - compatible with drush 11.3 and higher
1.0.x - compatible with drush 9 and higher (up to drush 11.2)


REQUIREMENTS
------------

 * This module requires drush module.

INSTALLATION
------------

The installation of this module is like other Drupal modules.

 1. Install:
   1. Composer: Copy the install comand from the module page. It will be similar to this, but with the actual version:

    composer require 'drupal/config_import_single:^2.0'
 
 
   2. Manually: Copy/upload the 'config_import_single' module to the modules directory.

 2. Enable:
    1. Drush: en -y config_import_single
    2. Interface: the 'config_import_single' module in 'Extend'.
   (/admin/modules) 

USE
-------------

 * Import your configuration with drush 
    ```drush cis ../path_to_the_folder/
    ```

If you give the ok or make some changes, I can make a patch.

Thanks for the module and have a good day :)

โœจ Feature request
Status

RTBC

Version

2.0

Component

Documentation

Created by

๐Ÿ‡ช๐Ÿ‡ธSpain candelas

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

Merge Requests

Comments & Activities

  • Issue created by @candelas
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    @candelas
    The format is not ok according to README.md template suggestions โ†’ .

  • First commit to issue fork.
  • Status changed to Needs review 5 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia sakthi_dev

    Thanks @candelas @ravi-kant. Created a MR for creating Readme file.

  • ๐Ÿ‡ช๐Ÿ‡ธSpain candelas

    @ravi kant you are right. Thanks for the link. I was making something fast, but better well done.
    @sakthi_dev now I am leaving the computer and can't make the changes. Would you like to make them? If not, later this week, I can :)

  • Status changed to Needs work 5 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi sakthi_dev

    I reviewed your MR!6 and it doesn't address comment #2. This should be needs work status.

    Thank you

  • ๐Ÿ‡ช๐Ÿ‡ธSpain candelas

    Hello

    For what I see in my agenda, I will be able to collaborate to implement #2 the weekend.
    @sakthi_dev if you have not made it before, you can later copy and paste.

    Have a good day

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Raveen Kumar

    Raveen Thakur โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 5 months ago
  • ๐Ÿ‡ช๐Ÿ‡ธSpain candelas

    @Raveen Thakur you are fast! :)
    I miss the main reason that made me propose the readme: to have the command in it and not to have to search in the code. As a site builder, I find it very useful.
    Thanks for your work

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Raveen Kumar

    @candelas :)

  • Status changed to Needs work 5 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!6, the patch is not cleanly applied.

    1.  6.diff.txt:41: trailing whitespace.
    
    warning: 1 line adds whitespace errors.
    
    2. In Table of contents, Recommended module is given however, details section of recommended module is missing.
    
    
  • Status changed to Needs review 5 months ago
  • ๐Ÿ‡ช๐Ÿ‡ธSpain candelas

    @ravi-kant tomorrow I will have time to work in the Drupal site.
    @raveen-thakur doesn't considere that including the drush command is important.
    For me the README.md function is facilitate to the user the module learning.
    If that is not going to be in it, thanks for all and here finish my collaboration :)

    Have a good day!

  • Status changed to Needs work 4 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!6, the file has still some issues:

    1.  6.diff.txt:40: trailing whitespace.
    
    warning: 1 line adds whitespace errors.
    
    
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Raveen Kumar

    @Nupur, which testing method you are following on it?

  • Status changed to Needs review 4 months ago
  • Status changed to RTBC 4 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines paraderojether

    Hi Raveen Thakur,

    I reviewed MR!6, applied against Config import single 2.0.x-dev, and confirmed the MR is applied and the README.md is also added.

    I attached screenshots for reference.
    Thank you.

  • Status changed to Needs work 4 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi Raveen Thakur

    I reviewed your changes in MR!6 and Project name and introduction is missing dot console into drush and you shouldn't say module only instead of The Config import single module on introduction. For the Requirements section since drush is a core module replace the requirements section to This module requires no modules outside of Drupal core.

    Thank you

  • Status changed to Needs review 4 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Raveen Kumar

    Please Review.

  • Status changed to RTBC 4 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi Raveen Thakur

    I reviewed your changes in MR!6, which addressed comment #20 and the README.md is following the template. โ†’

    Thank you.

Production build 0.69.0 2024