Update Readme.txt to Readme.md

Created on 16 February 2024, 11 months ago
Updated 19 March 2024, 10 months ago

Problem/Motivation

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

📌 Task
Status

Fixed

Version

1.0

Component

Documentation

Created by

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

Merge Requests

Comments & Activities

  • Issue created by @thakurnishant_06
  • Merge request !2updated readme → (Open) created by thakurnishant_06
  • Open in Jenkins → Open on Drupal.org →
    Core: 10.2.1 + Environment: PHP 8.1 & MariaDB 10.3.22
    last update 11 months ago
    4 pass
  • Pipeline finished with Canceled
    11 months ago
    Total: 114s
    #96541
  • Open in Jenkins → Open on Drupal.org →
    Core: 10.2.1 + Environment: PHP 8.1 & MariaDB 10.3.22
    last update 11 months ago
    4 pass
  • Status changed to Needs review 11 months ago
  • Updated the readme file kindly review changes.

  • Pipeline finished with Failed
    11 months ago
    Total: 216s
    #96545
  • Status changed to RTBC 11 months ago
  • 🇵🇭Philippines clarkssquared

    Hi

    I applied the MR !2 and I confirmed that it creates a README.md file according to Drupal standards, below is the README content that the MR created.

    # Micro Node
    
    This module integrates node entities with a [micro site](https://www.drupal.org/project/micro_site).
    
    For a full description of the module, visit the
    [project page](https://www.drupal.org/project/micro_node).
    
    Submit bug reports and feature suggestions, or track changes in the
    [issue queue](https://www.drupal.org/project/issues/micro_node).
    
    
    ## Table of contents
    
    - Requirements
    - Installation
    - Configuration
    - Maintainers
    
    
    ## Requirements
    
    This module requires the following modules:
    
    - [micro site](https://www.drupal.org/project/micro_site).
    
    
    ## 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).
    
    
    ## Configuration
    
    - It is highly recommended to not use user 1 when managing micro sites with
     nodes, or any user with the permission "bypass node access". Otherwise, these
     users will see any nodes published on any micro sites. You should create at
     least another admin like role, role which do not have this permission.
    
    
    ## Maintainers
    
  • 🇫🇷France flocondetoile Lyon

    Thanks. Committed.

    • 0a9a4b65 committed on 8.x-1.x
      Issue #3421860 by thakurnishant_06, flocondetoile: Update Readme.txt to...
  • Status changed to Fixed 10 months ago
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024