Replace README.txt with README.md

Created on 14 November 2022, about 2 years ago
Updated 30 November 2023, about 1 year ago

We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation.

Follow this pattern
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... โ†’

๐Ÿ“Œ Task
Status

RTBC

Version

1.0

Component

Documentation

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia phpsubbarao

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

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Merge request !1Update README.txt โ†’ (Open) created by Nila Hyalij
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Issue is found in the patch.

    git.drupalcode.org_project_field_delimiter_-_merge_requests_1.diff.txt:16: trailing whitespace.
    
    git.drupalcode.org_project_field_delimiter_-_merge_requests_1.diff.txt:21: trailing whitespace.
    
    warning: 2 lines add whitespace errors.
  • Assigned to sourabhjain
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia sourabhjain

    Let me work on it.

  • Issue was unassigned.
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia sourabhjain

    I have resolved the issues. Please review.

  • Status changed to Needs work over 1 year ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines clarkssquared

    Hi

    I applied the updated MR !1 and confirmed that the patch applies cleanly and replaced the README.txt to README.md, however the README.md format did not follow README.md Drupal Format โ†’ , hence I will move this to needs work for formatting issue.

    Please also look at the screenshot attached

    Thank you

  • Assigned to nitin_lama
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India

    Please review.

  • Issue was unassigned.
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India
  • Status changed to Needs work over 1 year ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines clarkssquared

    Hi nitin_lama

    I applied the updated MR !1 to my local and confirmed that it fixed the formatting issue of the README.md file, however, according to the Drupal format for README.md, the Requirements and Configurations sections are missing from the README.md file which are required. README.md Drupal Format โ†’ for convenience below are the summary of sections that is mentioned in Drupal.org

    README sections
    Drupal recommends the following README sections:

    Project name and introduction (required)
    Table of contents (optional)
    Requirements (required)
    Recommended modules (optional)
    Installation (required, unless a separate INSTALL.md is provided)
    Configuration (required)
    Troubleshooting & FAQ (optional)
    Maintainers (optional)

    Please look at the screenshot attached for your reference.

    Thank you

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Anjali Mehta โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review about 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Kindly Review The Changes .
    Thank You.

  • Status changed to RTBC about 1 year ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines clarkssquared

    Hi

    I applied the MR !1 again after the commit #13 and I confirmed that it creates a README.md and according to Drupal's README template, I wont upload any screenshots but instead this is the README.md content that the updated MR !1 creates.

    # Field Delimiter (Multi Value Field Formatter)
    
    Field Delimiter provides an additional setting for field formatters, allowing
    multi-value fields to be displayed with a delimiter between the values.
    
    For a full description of the module, visit the
    [project page](https://www.drupal.org/project/field_delimiter).
    
    Submit bug reports and feature suggestions, or track changes in the
    [issue queue](https://www.drupal.org/project/issues/field_delimiter).
    
    
    ## Table of contents
    
    - Requirements
    - Installation
    - Configuration
    - Dependencies
    - Maintainers
    
    
    ## Requirements
    
    This module requires no modules outside of Drupal core.
    
    
    ## Installation
    
    Install as you would normally install a contributed Drupal module. For further
    information, see
    [Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
    
    
    ## Configuration
    
    The module has no menu or modifiable settings. There is no configuration.
    
    
    ## Dependencies
    
    The Drupal 7 version depends on
    [Field formatter settings](https://www.drupal.org/project/field_formatter_settings)
    API module.
    
    
    ## Maintainers
    
    - andrewmacpherson - [andrewmacpherson](https://www.drupal.org/u/andrewmacpherson)
    - purushotam.rai - [purushotam.rai](https://www.drupal.org/u/purushotamrai)
    
Production build 0.71.5 2024