Replace README.txt with README.md

Created on 16 November 2022, almost 2 years ago
Updated 22 February 2024, 9 months 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 Pracheth

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.

  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Bushra Shaikh

    I applied the MR!1, got below errors:

    error: patch failed: image_hotspots.install:41
    error: image_hotspots.install: patch does not apply
    error: patch failed: image_hotspots.module:1
    error: image_hotspots.module: patch does not apply
    error: patch failed: includes/image_hotspots.admin.inc:1
    error: includes/image_hotspots.admin.inc: patch does not apply
    error: patch failed: includes/image_hotspots.db.inc:1
    error: includes/image_hotspots.db.inc: patch does not apply
    error: templates/image-hotspots-data.tpl.php: already exists in working directory
    error: templates/image-hotspots-element.tpl.php: already exists in working directory
    error: patch failed: themes/hotspots_color_adm.js:1
    error: themes/hotspots_color_adm.js: patch does not apply
    error: patch failed: themes/image_hotspots.css:41
    error: themes/image_hotspots.css: patch does not apply
    error: patch failed: themes/image_hotspots.js:1
    error: themes/image_hotspots.js: patch does not apply
    error: themes/image_hotspots_adm.css: already exists in working directory
    
    
  • Assigned to nitin_lama
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India

    Updating README.md as per README.md template. โ†’

  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    @nitin Issue still exists in the patch.

    error: patch failed: image_hotspots.install:41
    error: image_hotspots.install: patch does not apply
    error: patch failed: image_hotspots.module:1
    error: image_hotspots.module: patch does not apply
    error: patch failed: includes/image_hotspots.admin.inc:1
    error: includes/image_hotspots.admin.inc: patch does not apply
    error: patch failed: includes/image_hotspots.db.inc:1
    error: includes/image_hotspots.db.inc: patch does not apply
    error: templates/image-hotspots-data.tpl.php: already exists in working directory
    error: templates/image-hotspots-element.tpl.php: already exists in working directory
    error: patch failed: themes/hotspots_color_adm.js:1
    error: themes/hotspots_color_adm.js: patch does not apply
    error: patch failed: themes/image_hotspots.css:41
    error: themes/image_hotspots.css: patch does not apply
    error: patch failed: themes/image_hotspots.js:1
    error: themes/image_hotspots.js: patch does not apply
    error: themes/image_hotspots_adm.css: already exists in working directory
    
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India

    @nupurbadola i don't see any issue in applying the diff of the MR on master branch. Waiting for anyone to review. Also can you share what steps do you follow. Thanks.

  • Status changed to RTBC about 1 year ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia rushiraval

    I reviewed MR!3 for Readme.md file. It is as per Drupal Recommendation. Readme.md can be updated as per MR!3.

  • Status changed to Needs work 9 months ago
  • ๐Ÿ‡ง๐Ÿ‡ชBelgium JeroenT ๐Ÿ‡ง๐Ÿ‡ช

    This patch contains a lot of unrelated changes.

  • Assigned to nitin_lama
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India
  • Status changed to Needs review 9 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India

    I've fixed the MR issues. True there are alot of unrelated changes. i believe a new MR is needed. Please review. Thanks.

  • Issue was unassigned.
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia nitin_lama India
  • Pipeline finished with Failed
    9 months ago
    Total: 3692s
    #94670
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines clarkssquared

    Hi

    I applied the MR !3, I confirmed that it changes the content of README file according to Drupal Standards.

    # Image Hotspots
    
    Image hotspots module allows you to mark the different areas of the image by
    text labels (similar to annotations). You can mark a person on the image or a
    part of the image. Hotspots are responsive. When you scale the image, hotspots
    scale proportionally.
    
    
    ## Table of contents
    
     - Installation
     - Configuration
     - Support
     - Maintainers
    
    
    ## Installation
    
    -  Install Image Hotspots module.
    -  Go to your content type manage fields page. It should have at least one
       Image field to work with hotspots.
    -  Click on the "`Edit`" link for the Image field and select
       "`Use image hotspots`" checkbox.
    -  Now you can add hotspots to the Image fields on node edit page.
    
    ## Configuration
    
    -  To set Minimal and Maximal resolutions for hotspots use the appropriate
       height/width fields in managed page.
    -  To allow add a link to the hotspots select checkbox on field manage page.
       After on node edit page hotposts form will show new field for the link.
    -  To set the color scheme go to `/admin/config/media/image-hotspots` and use a
       form to add, remove or edit the hotspot styles.
    
    ## Support
    
    - Feel free to report bugs and propositions in our Issue Queue
      http://drupal.org/project/image_hotspots
    
    - Image Hotspots for Drupal 7.x
      by [ ADCI, LLC team](www.adcillc.com)
    
    ## Maintainers
    
    - adcillc - https://www.drupal.org/u/adcillc
    - adci_contributor - https://www.drupal.org/u/adci_contributor
    - Denis Usov (usdv) - https://www.drupal.org/u/usdv
    - trim108 - https://www.drupal.org/u/trim108
    

    but I noticed that when I apply the MR there are unrelated commits that was included in the MR, please look at the cli snippet below

    โžœ  image_hotspots git:(8.x-1.0-beta4) curl https://git.drupalcode.org/project/image_hotspots/-/merge_requests/3.diff | patch -p1
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100 48891    0 48891    0     0  61227      0 --:--:-- --:--:-- --:--:-- 61809
    patching file README.md
    patching file image_hotspots.install
    patching file image_hotspots.module
    patching file 'includes/image_hotspots.admin.inc'
    patching file 'includes/image_hotspots.db.inc'
    patching file 'templates/image-hotspots-data.tpl.php'
    patching file 'templates/image-hotspots-element.tpl.php'
    patching file 'themes/hotspots_color_adm.js'
    patching file 'themes/image_hotspots.css'
    patching file 'themes/image_hotspots.js'
    patching file 'themes/image_hotspots_adm.css'
    โžœ  image_hotspots git:(8.x-1.0-beta4) โœ— 
    
    

    hence, I will retain the status to needs review

  • Status changed to Needs work 9 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!3, the file has still some issues:

    1. Project page and issue queue is missing.
    2. Requirement section which is mandatory is missing.
    3. Links should have a meaningful link text, for example:
    [Drupal](https://www.drupal.org/) (i.e. not just the URL)
    4. Two lines prior to ##/### headings
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Anjali Mehta

    Anjali Mehta โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 9 months ago
  • Pipeline finished with Failed
    9 months ago
    Total: 3692s
    #95768
  • Status changed to RTBC 9 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!3, the file is updated as per the readme.md file template.
    Hence marking it to RTBC.

Production build 0.71.5 2024