Update the README.md to follow best practices

Created on 7 February 2023, over 1 year ago
Updated 8 February 2023, over 1 year ago

Right now the README.md isn't following Drupal best practices โ†’ .

๐Ÿ› Bug report
Status

Fixed

Version

3.2

Component

Documentation

Created by

๐Ÿ‡บ๐Ÿ‡ธUnited States cedewey Denver, CO

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

Comments & Activities

  • Issue created by @cedewey
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States cedewey Denver, CO

    This is now ready for review.

  • Status changed to Needs work over 1 year ago
  • ๐Ÿ‡จ๐Ÿ‡ฆCanada chrisck

    These are very small nits from the README.me template guide โ†’ :

    1. ## Introduction
      A Drupal module that allows you to provide a customized administration menu for each role. For example, you can create an "Editor" menu, then assign that menu to to the "Content editor" role.
      

      Two lines before ## headings. Suggest we add an additional line space or remove Introduction heading and keep single line space.
       

    2. ## Requirements
      Two lines before ## headings.
       
    3. ## Installation
      Two lines before ## headings.
    4. ## Configuration
      Two lines before ## headings.
       
    5. ## Troubleshooting
      Two lines before ## headings.
       
    6. ## FAQ
      Two lines before ## headings.
    7. 1. **Q**: Is this the same as the "Administration Menu Source" module?
      **A**: No, AMSwap was built from scratch for Drupal 8 by a separate developer,
      but it was inspired by Administration Menu Source.

      Remove ordered list. Insert new line break for "A: ..." portion.
       

    8. ## Maintainers
      Two lines before ## headings.
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States cedewey Denver, CO

    Thanks for the feedback, I've updated the spacing and formatting accordingly.

  • @chrisck opened merge request.
  • ๐Ÿ‡จ๐Ÿ‡ฆCanada chrisck

    Adjusted the line spacings to two before the ## heading and one after :)

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Rinku Jacob 13 Kerala

    Rinku Jacob 13 โ†’ made their first commit to this issueโ€™s fork.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Rinku Jacob 13 Kerala

    @cedewey, I have made some changes on README.md file Based on README format. Please Review

  • Status changed to RTBC over 1 year ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States cedewey Denver, CO

    Ah, ok I misinterpreted that earlier feedback. :D Thanks both of you for the revisions, they look great.

    • d604f5f4 committed on 3.0.x
      Issue #3340013 by cedewey, chrisck, Rinku Jacob 13: Update the README.md...
  • Status changed to Fixed over 1 year ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States cedewey Denver, CO
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.69.0 2024