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...

CommentFileSizeAuthor
#15 Screenshot from 2023-05-30 17-59-59.png63 KBshiv_sharma

Issue fork config_inspector-3321574

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

phpsubbarao created an issue. See original summary.

Manoj Raj.R made their first commit to this issue’s fork.

Manoj Raj.R’s picture

Manoj Raj.R commented
Assigned: Unassigned » Manoj Raj.R

Manoj Raj.R opened merge request !2

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Active » Needs review

Committed according to the proposed solution.

Please review it!

Manoj Raj.R’s picture

Manoj Raj.R commented
Assigned: Manoj Raj.R » Unassigned

Shiv_Sharma made their first commit to this issue’s fork.

Shiv_Sharma opened merge request !5

shiv_sharma’s picture

shiv_sharma commented

Updated the Readme.md file with drupal readme template

MR 5

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs review » Needs work

This is still not proper Readme template.

I will work on it.

Manoj Raj.R’s picture

Manoj Raj.R commented

MR!2 should be mergeable with the latest update from README Template.

https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

nishant’s picture

nishant
Primary language English
commented

Readme.md is not as per the MD format.

Please Follow like this.
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules)
[Configuration API overview] (http://drupal.org/node/1667894)
[Configuration schema/metadata] (http://drupal.org/node/1905070)
[Introduce and complete configuration schemas in all of core] http://drupal.org/node/1910624#comment-7088154

nishant’s picture

nishant
Primary language English
commented
Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Needs work » Needs review

Updated Accordingly.

Please review.

shiv_sharma’s picture

shiv_sharma commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Screenshot from 2023-05-30 17-59-59.png63 KB

It looks good @manoj @nishant
screenshot
Moving to RTBC

gábor hojtsy made their first commit to this issue’s fork.

gábor hojtsy’s picture

gábor hojtsy
he/him
Primary language Hungarian
Location Hungary
commented
Status: Reviewed & tested by the community » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.