Replace README.txt with READEME.md format

Created on 9 November 2022, about 2 years ago
Updated 7 June 2023, over 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

šŸ“Œ Task
Status

RTBC

Version

1.0

Component

Documentation

Created by

šŸ‡®šŸ‡³India nitapawar

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.

  • Issue was unassigned.
  • Status changed to Needs review almost 2 years ago
  • šŸ‡®šŸ‡³India Sonal Gyanani

    Fixed formatting issue according to Readme.md template ā†’ format.
    Please review.
    Thanks

  • Status changed to Needs work almost 2 years ago
  • šŸ‡®šŸ‡³India Manoj Raj.R Chennai

    Fixed some fixes which has other module reference.

    Please review.

  • Status changed to Needs review over 1 year ago
  • šŸ‡®šŸ‡³India Nupur Badola

    Issue is still exists in the patch.

    git.drupalcode.org_project_config_rewrite_-_merge_requests_5.diff.txt:9: trailing whitespace.
    The Configuration Rewrite module rewrites existing configuration on module
    git.drupalcode.org_project_config_rewrite_-_merge_requests_5.diff.txt:11: trailing whitespace.
    in the config directory. Stops with an error, if you are going to rewrite
    git.drupalcode.org_project_config_rewrite_-_merge_requests_5.diff.txt:15: trailing whitespace.
    This can be handy, if you like to overwrite existing configuration
    git.drupalcode.org_project_config_rewrite_-_merge_requests_5.diff.txt:17: trailing whitespace.
    use install or update hooks. You can just place your configuration
    git.drupalcode.org_project_config_rewrite_-_merge_requests_5.diff.txt:19: trailing whitespace.
    module folder. Afterwards the existing configuration will be rewritten
    warning: squelched 1 whitespace error
    warning: 6 lines add whitespace errors.
  • Status changed to Needs work over 1 year ago
  • šŸ‡µšŸ‡­Philippines clarkssquared

    Hi

    I also encountered the same issue as I tried to apply MR !5 to my local.

    config_rewrite git:(8.x-1.5) curl https://git.drupalcode.org/project/config_rewrite/-/merge_requests/5.diff | git apply -v
    % Total % Received % Xferd Average Speed Time Time Time Current
    Dload Upload Total Spent Left Speed
    100 3642 0 3642 0 0 1078 0 --:--:-- 0:00:03 --:--:-- 1082
    :9: trailing whitespace.
    The Configuration Rewrite module rewrites existing configuration on module
    :11: trailing whitespace.
    in the config directory. Stops with an error, if you are going to rewrite
    :15: trailing whitespace.
    This can be handy, if you like to overwrite existing configuration
    :17: trailing whitespace.
    use install or update hooks. You can just place your configuration
    :19: trailing whitespace.
    module folder. Afterwards the existing configuration will be rewritten
    Checking patch README.md...
    Checking patch README.txt...
    Applied patch README.md cleanly.
    Applied patch README.txt cleanly.
    warning: squelched 1 whitespace error
    warning: 6 lines add whitespace errors.
    āžœ config_rewrite git:(8.x-1.5) āœ—

    However, the patch successfully replaced the README.txt file with README.md, hence I will move this to needs work to cater the whitespace errors being flagged in the MR !5 patch

    Please look at the screenshots attached for your reference

    Thank you

  • First commit to issue fork.
  • Status changed to Needs review over 1 year ago
  • Status changed to RTBC over 1 year ago
  • šŸ‡µšŸ‡­Philippines clarkssquared

    Hi

    I applied the updated MR !5 to my local and confirmed that the patch applied cleanly without the whitespace error, and README.txt was replaced with README.md file, hence the patch is good and functional.

    Please look at the screenshot attached for your reference, moving this to RTBC

    Thank you

Production build 0.71.5 2024