README.txt has no content and replace README.txt with README.md

Created on 4 October 2023, about 1 year ago
Updated 5 December 2023, about 1 year ago

Problem/Motivation

We should consider switching from using README.txt to README.md for our documentation.
Especially since we've transitioned to GitLab.
Markdown offers a more visually appealing rendering compared to plain .txt files.

Steps to reproduce

Create README.md file in place of README.txt file.
Needs proper documentaion in README.md File.

๐Ÿ“Œ Task
Status

RTBC

Version

1.0

Component

Documentation

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia yogesh_ghatode

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

Merge Requests

Comments & Activities

  • Issue created by @yogesh_ghatode
  • First commit to issue fork.
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia sandipta

    Please review Merge Request

  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi sandipta

    I reviewed your MR!15 but it doesn't follow the README.md template โ†’ . These are the sections that Drupal recommends:

    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)

    Thank you

  • Assigned to AditiVB
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia AditiVB

    i will work on this .

  • Issue was unassigned.
  • Status changed to Needs review about 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia AditiVB

    Created .md file . Please review

  • Status changed to Needs work about 1 year ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi Aditi Saraf

    I reviewed your patch it also not follow README.md template.

    - # Nature Blog Drupal Module [remove Drupal Module since it is a theme and not a module]
    - ## Table of contents [Missing information in table of contents section]
    - ## Configuration [You should explain how enabling/disabling the theme will affect the site]
    - ## Maintainer [Wrong format this a example of the format (- Daniel F. Kudwien - [sun]( https://www.drupal.org/u/sun โ†’ ))]

    Thank you.

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

    Addressed the comments in #8. Please review.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed the patch, the only issue I found out was the incorrect for of Maintainers
    It should be for instance "Peter Wolanin - [pwolanin]( https://www.drupal.org/u/pwolanin โ†’ )", like this.
    Sending it to need work.

  • Status changed to Needs work about 1 year ago
  • Assigned to AditiVB
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia AditiVB

    checking this

  • Issue was unassigned.
  • Status changed to Needs review about 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia AditiVB

    updated the patch file

  • Status changed to Needs work about 1 year ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi Aditi Saraf

    Based on comment #11 incorrect format for the "Maintainers" section not on the "Author" section. "Maintaners" section format should be example

    ## Maintainers
    
    - Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
    - Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)
    - Stefan M. Kudwien - [smk-ka](https://www.drupal.org/u/smk-ka)
    - Dave Reid - [Dave Reid](https://www.drupal.org/u/dave-reid)

    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

    Updated the file. kindly review the changes.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!15, the name of the maintainers are still missing.

    [Jitendra Verma](drupal.org/u/jitendra-verma)
    - [Asheesh kumar Pal](drupal.org/u/asheesh-kumar-pal)
    - Kritika Gautam - [Kritika_21](drupal.org/u/kritika_21)
    
  • Status changed to Needs work about 1 year ago
  • Status changed to Needs review about 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    The maintainers does not show their full name on their user profile. It is not possible to show it.

  • Status changed to Needs work about 1 year ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines kenyoOwen

    Hi Anjali Mehta

    I reviewed and confirmed that the maintainer is correct. But the title is still module # Nature Blog Drupal Module while this project is theme. It also has module text in the introduction

    The Nature Blog module is designed to enhance your Drupal website with a feature-rich
    blogging platform focused on nature and environmental topics.

    Thank you.

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

    kindly review the changes.

  • First commit to issue fork.
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ankithashetty Karnataka, India

    While reviewing noticed the following phpcs errors:

    FILE: /nature_blog/README.md
    ----------------------------------------------------------------------------------------
    FOUND 0 ERRORS AND 5 WARNINGS AFFECTING 5 LINES
    ----------------------------------------------------------------------------------------
      3 | WARNING | Line exceeds 80 characters; contains 84 characters
      4 | WARNING | Line exceeds 80 characters; contains 89 characters
      5 | WARNING | Line exceeds 80 characters; contains 89 characters
     46 | WARNING | Line exceeds 80 characters; contains 87 characters
     52 | WARNING | Line exceeds 80 characters; contains 95 characters
    ----------------------------------------------------------------------------------------

    Addressed them in the latest commit. Thanks!

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

    Hi ankithashetty

    I reviewed the new changes and confirmed it fixed the remaining issues and it follows the README.md template.

    Thank you

Production build 0.71.5 2024