Replace the README.txt file with a README.md file

Created on 22 June 2023, over 1 year ago
Updated 21 July 2023, over 1 year ago

Problem/Motivation

We can use README.md instead of README.txt to make use of the nicer rendering via markdown.

Follow the pattern in the README.md template

📌 Task
Status

RTBC

Version

2.0

Component

Documentation

Created by

🇮🇳India Priya_Degwekar

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

Comments & Activities

  • Issue created by @Priya_Degwekar
  • Assigned to Priya_Degwekar
  • @priya_degwekar opened merge request.
  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • 🇮🇳India Priya_Degwekar

    Hi, Please check #MR4.
    Thanks.

  • Status changed to Needs work over 1 year ago
  • @Priya_Degwekar , on applying MR4 getting errors ->

    4.patch:315: trailing whitespace.
    1. Install the User Instance module as you would normally install a contributed Drupal module.
    error: composer.json: already exists in working directory
    error: patch failed: README.txt:26
    error: README.txt: patch does not apply
    error: patch failed: custom_account_link.links.menu.yml:10
    error: custom_account_link.links.menu.yml: patch does not apply
    error: patch failed: custom_account_link.module:1
    error: custom_account_link.module: patch does not apply
    error: patch failed: custom_account_link.routing.yml:4
    error: custom_account_link.routing.yml: patch does not apply
    error: patch failed: src/Form/CustomAccountLinkSettings.php:35
    error: src/Form/CustomAccountLinkSettings.php: patch does not apply
    error: patch failed: src/Plugin/Menu/RegisterMenuLink.php:66
    error: src/Plugin/Menu/RegisterMenuLink.php: patch does not apply
    error: patch failed: custom_account_link.module:1
    error: custom_account_link.module: patch does not apply

  • Assigned to nitin_lama
  • 🇮🇳India nitin_lama India

    Addressed 5. Fixed trailing white space. Please review. Thanks.

  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • 🇮🇳India Priya_Degwekar

    Hi @Tanuja Bohra, Thanks for the review.
    But I have clearly mentioned that only check two commits. I think you have applied whole MR4 that is why it does not apply.
    Anyway, I am attaching a patch here. Please review again.
    Thanks :)

  • Status changed to RTBC over 1 year ago
  • 🇮🇳India Harshita mehra

    Hello, @Priya_Degwekar patch #9 is working fine.
    Thanks!

  • 🇮🇹Italy apaderno Brescia, 🇮🇹
    +## Installation
    +
    +1. Install the User Instance module as you would normally install a contributed
    +   Drupal module.
    +2. Visit https://www.drupal.org/node/1897420 for further information.

    README template uses different markup.

    ## 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).
    +## Maintainers
    +
    + - mortona2k - https://www.drupal.org/u/mortona2k
    

    The link for the maintainer should be given using the following markup.

    - [mortona2k](https://www.drupal.org/u/mortona2k)
    
  • Status changed to Needs work over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    As a side note, the Drupal coding standards are still saying that documentation files should use the .txt extension and their section about the Markdown markup is still empty. That means there still no consensus on which markup a .md file should use.
    Project maintainers are free to not adopt these changes, considering that a new commit could be required in the future.

  • Status changed to Needs review over 1 year ago
  • 🇮🇳India Priya_Degwekar

    Hi @apaderno, thanks for the corrections.
    I've worked accordingly and created a patch.
    Please review.
    thanks.

  • Status changed to Needs work over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    It's quite good! There are just few changes to do.

    +# Custom Account Link
    +
    +The user module creates a link "My account" to /user in the account menu.
    +This module lets you override the label with text, or the current user's name.

    The module name is User, capitalized.

    +## Configuration
    +
    +- Navigate to Administration > Extend and enable the module.
    +- Go to /admin/config/people/custom_account_link for configuration.

    Starting from Drupal 8, modules cannot be anymore enabled/disabled; they can only be installed or uninstalled. The first point is not anymore valid and it needs to be removed.
    Instead of Go to, it is better to say Visit: Visit /admin/config/people/custom_account_link to change the module configuration.
    Since there will be a single point, it is not necessary to make a list.

    +## Maintainers
    +
    + - mortona2k - [mortona2k](https://www.drupal.org/u/mortona2k)

    Since the user profile does not show first and last name, it is better to use the following markup, which avoids to repeat the user name.

    +## Maintainers
    +
    + - [mortona2k](https://www.drupal.org/u/mortona2k)

    Since there is just a maintainer, there is no need to use a list.

  • 🇮🇳India Priya_Degwekar

    Please review the updated patch.

  • Status changed to Needs review over 1 year ago
  • 🇮🇳India Priya_Degwekar

    Updated the patch.
    Check this file below readme.patch

  • Status changed to RTBC over 1 year ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    The last patch makes the correct changes.

Production build 0.71.5 2024