Closed (fixed)
Project:
Qwantsearch
Version:
8.x-1.x-dev
Component:
Documentation
Priority:
Minor
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
6 Oct 2022 at 11:18 UTC
Updated:
11 Jul 2023 at 11:34 UTC
Jump to comment: Most recent
Comments
Comment #4
immaculatexavier commentedCommitted in accordance to the stated requirement
Comment #5
Manoj Raj.R commented@immaculatexavier
I was wondering how to make this changes.
Could you please provide steps how your proposing your solution.
Comment #6
elberHi @Manoj Raj.R I think you just need to rename the README.txt file to README.md.
But if you want a pattern of READMEs files in Drupal, please see the link below:
https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
Comment #7
Manoj Raj.R commented@elber
I clearly understood how we can rename the README.txt to README.md which to probably use Markdown behavior for future purposes.
Just got idea on this :
https://www.drupal.org/docs/develop/git/using-git-to-contribute-to-drupa...
Comment #8
Manoj Raj.R commentedCommitted with proper Installation Notes.
Comment #9
emarinho commentedI'll review it!
Comment #10
emarinho commentedEverything is okay!!
Comment #11
damienmckennaThe file needs more work beyond renaming the file - the headings and links should be changed to Markdown syntax, etc.
Comment #12
emarinho commentedOk! Thanks, @DamienMcKenna! I'll work on it!
Comment #13
Manoj Raj.R commentedComment #14
emarinho commentedHi, @Manoj Raj.R! Your commit still need some work. I'll fix those that are left. Also, please, double check before working in a issue if someone already assigned to it to avoid re-working.
Comment #15
emarinho commentedHere comes some changes. Please, kindly review it. :)
Comment #16
erikaagp commentedthe changes look good for me. Let's see if it's approved by the mantainers, or if needs more work to keep working on it. :)
Comment #17
Nila Hyalij commentedchanges looks good for me
Comment #18
avpadernoThe Drupal coding standards, under Naming Conventions / File names, says:
Comment #19
damienmckenna@apderno: That seems to be out of date and misses the point of the newer Markdown syntax files that Gitlab supports; I updated the docs page to reference the newer standard.
Comment #20
avpaderno@DamienMcKenna It could be outdated, but until #3012906: Add Markdown to list of module documentation file types isn't closed, that is what the coding standards say.
Comment #21
damienmckennaCore already set the standard by converting to a Markdown file (#3192842: Make our README more welcoming by converting it into an "entrypoint" into the Drupal ecosystem). But we're going off-tangent here.
Comment #22
grimreaperComment #25
grimreaper