Replace README.txt with README.md

Created on 17 November 2022, about 2 years ago
Updated 28 February 2024, 10 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 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.

  • Merge request !1Update README.md โ†’ (Open) created by nitapawar
  • Status changed to Needs work 12 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines clarkssquared

    Hi

    upon checking the MR !1 I see that it has missing required README sections please refer to this Drupal README.md template โ†’

    I will move this to needs work

  • First commit to issue fork.
  • Issue was unassigned.
  • Status changed to Needs review 12 months ago
  • Status changed to Needs work 11 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!1, the patch is not cleanly applied.

    a) 1.diff.txt:43: trailing whitespace.
    1. Get an API key from NASA, if you don't have it.
    1.diff.txt:46: trailing whitespace.
    3. To show the Astronomical Picture Of the Day go to Structure > Block layout > Place block and
    warning: 2 lines add whitespace errors.
    
    b) Maintainer section does not follow readme.md file template instruction 
    it should be like this: 
    ## Maintainers
    
    - Daniel F. Kudwien - [sun](https://www.drupal.org/u/sun)
    - Peter Wolanin - [pwolanin](https://www.drupal.org/u/pwolanin)
    
    And, also there is only one maintainer, then hypen should be removed.
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia mohd sahzad

    Mohd Sahzad โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 11 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia mohd sahzad

    Hello @nitapawar,
    I have updated readme.md file in last commit please review

  • Assigned to thakurnishant_06
  • Status changed to Needs work 11 months ago
  • It still doesn't follow the Drupal standards. I will work on this

  • Status changed to Needs review 11 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia mohd sahzad

    Hello @nitapawar,
    I have updated please review again

  • Status changed to Needs work 11 months ago
  • @Mohd Sahzad,

    Please don't change the status if the files require changes or until all changes are done. I have assigned this issue to myself, so please wait until the issue is unassigned. Kindly adhere to the issue etiquette for contributions โ†’ , and ensure that you follow the Drupal README.md โ†’ to check the required standards for the README file.

    Changing status back to Need Work as there are many unnecessary changes that needs to be removed

  • Issue was unassigned.
  • Status changed to Needs review 11 months ago
  • Status changed to RTBC 11 months ago
  • ๐Ÿ‡ต๐Ÿ‡ญPhilippines clarkssquared

    Hi

    I applied the MR !1 after commit #15 and I confirmed that the README.md file now follows the Drupal template for README.md, below is the output of the README.md File.

    # Access NASA API
    
    This module allows users to access the NASA API directly from Drupal. It provides 
    seamless integration with NASA services for retrieving relevant data.
    
    For a full description of the module, visit the
    [project page](https://www.drupal.org/project/nasa).
    
    Submit bug reports and feature suggestions, or track changes in the
    [issue queue](https://www.drupal.org/project/issues/nasa).
    
    
    ## Table of contents
    
    - Requirements
    - Installation
    - Configuration
    - Maintainers
    
    
    ## Requirements
    
    This module requires no modules outside of Drupal core.
    
    
    ## 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
    
    1. Obtain an API key from NASA if you don't have one.
     [NASA API Key](https://api.nasa.gov/index.html#apply-for-an-api-key>)
    1. Navigate to _/admin/config/services/nasa_ and enter your API key in the 
    provided field.
    1. To display the Astronomical Picture Of the Day, go to Structure > Block 
    layout > Place block, and choose "NASA APOD."
    
    
    ## Maintainers
    
    - Carlos Costa - [ccosta](https://www.drupal.org/u/ccosta)
    
  • Status changed to Needs work 11 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

    Reviewed MR!1, the patching is not cleanly applied.

    1.diff.txt:11: trailing whitespace.
    This module allows users to access the NASA API directly from Drupal. It provides
    1.diff.txt:47: trailing whitespace.
    1. Navigate to _/admin/config/services/nasa_ and enter your API key in the
    1.diff.txt:49: trailing whitespace.
    1. To display the Astronomical Picture Of the Day, go to Structure > Block
    warning: 3 lines add whitespace errors.
    
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    ravi kant โ†’ made their first commit to this issueโ€™s fork.

  • Status changed to Needs review 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia ravi kant Jaipur

    Resolved the whitespace issue.

  • Status changed to RTBC 10 months ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Nupur Badola

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

Production build 0.71.5 2024