README.md file is missing

Created on 22 January 2024, 5 months ago
Updated 29 February 2024, 4 months ago
๐Ÿ› Bug report
Status

RTBC

Version

1.0

Component

Documentation

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia aman_lnwebworks

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

Merge Requests

Comments & Activities

  • Issue created by @aman_lnwebworks
  • Assigned to chetan 11
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia chetan 11
  • Merge request !1fixed โ†’ (Open) created by chetan 11
  • Issue was unassigned.
  • Status changed to Needs review 5 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia chetan 11

    Please check the above MR.

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

    Hi chetan 11,

    I applied your MR !1 and I verified that the MR creates README.md file, however, your MR creates Readme.md file instead of README.md I suggest that you must change the filename to README.md.

    Below is the output of the Readme file that your MR created

    # Self Entity Reference field
    
    Defines an entity reference to self via a computed field. 
    This allows rendering a node as an entity reference field with a different display mode.
    
    1) Displaying a "Hero" or header view mode within the full content view mode.
    2) Rendering a different view mode within the search_index view mode. This can be helpful if using layout builder on the full content view mode but want to index additional fields.
    
    For a full description of the module, visit the
    [project page](https://www.drupal.org/project/self_entity_reference).
    
    Submit bug reports and feature suggestions, or track changes in the
    [issue queue](https://www.drupal.org/project/issues/self_entity_reference).
    
    ## Table of contents
    
    - Requirements
    - Related modules
    - Installation
    - Configuration
    - Maintainers
    
    ## Requirements
    
    This module doesn't require any module outside of Drupal core.
    
    ## Related modules
    
    - [Role Delegation](http://drupal.org/project/role_delegation),
    - [RoleAssign](http://drupal.org/project/roleassign),
    - [Administer Users by Role](http://drupal.org/project/administerusersbyrole)
    modules that enable user access to assign roles to other users where the
    auditing of Self Entity Reference field is a nice fit.
    
    - [Role Change Notify](http://drupal.org/project/role_change_notify)
    the mirror functionality of Self Entity Reference field, notifying the user when a role is
    added to their account.
    
    
    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
    
    1. Displaying a "Hero" or header view mode within the full content view mode.
    Rendering a different view mode within the search_index view mode. This can be helpful if using layout builder on the full content view mode but want to index additional fields.
    
    ## Maintainers
    
    - Chris Snyder  - [Chris Snyder ](https://www.drupal.org/u/chrissnyder)
    
    **Supporting organizations:**

    If possible, re write the Readme content that will look similar to Drupal README.md template โ†’

    So moving this to needs work to settle the following:

    1. Change the filename of Readme.md to README.md
    2. rewrite the README.md file to match the Drupal README template (if possible)

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    ravi kant โ†’ made their first commit to this issueโ€™s fork.

  • Merge request !2Created new README.md file โ†’ (Open) created by ravi kant
  • Status changed to Needs review 5 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    I have created MR !2.

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

    Hi

    I applied your MR !2 and I confirmed that the Readme.md file in your previous MR is now changed to README.md but in this part

    ## Table of contents
    
    - Requirements
    - Related modules
    - Installation
    - Configuration
    - Maintainers
    
    
    ## Requirements
    
    This module doesn't require any module outside of Drupal core.
    
    
    ## Related modules
    
    - [Role Delegation](http://drupal.org/project/role_delegation)
    - [RoleAssign](http://drupal.org/project/roleassign)
    - [Administer Users by Role](http://drupal.org/project/administerusersbyrole)
      modules that enable user access to assign roles to other users where the
      auditing of Self Entity Reference field is a nice fit.
    
    - [Role Change Notify](http://drupal.org/project/role_change_notify)
      the mirror functionality of Self Entity Reference field, notifying the user
      when a role is added to their account.
    
    
    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).

    I noticed that in Installation there is no ## Installation heading, can you please add it? like this one from Drupal

    ## 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).
  • Assigned to nitin_lama
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama

    Please review.

  • Issue was unassigned.
  • Status changed to Needs review 5 months ago
  • Status changed to RTBC 4 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!2, the file is updated as per the readme.md file template.
    Hence marking it to RTBC.

Production build 0.69.0 2024