Closed (fixed)
Project:
Slick Carousel
Version:
8.x-1.x-dev
Component:
Code
Priority:
Normal
Category:
Feature request
Assigned:
Unassigned
Reporter:
Created:
10 May 2019 at 20:03 UTC
Updated:
24 May 2019 at 21:14 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
thallesFollow the patch!
Comment #4
thallesComment #5
gausarts commentedYou are too quick ;)
Good idea, thank you!
This file was referenced elsewhere in the codebase, we must update them accordingly to avoid missing references:
If you do this, you must also update the rest of .txt files to get consistent with the new intention.
If I were you, I would leave it alone, as we already have 2.x branch which already has .md files in place.
But feel free to go ahead on this, but please just update the references as needed. Thank you!
Comment #6
thallesI do in 1.x because in 2.x it's inside docs, so I wanted to check with you before
Comment #7
gausarts commented2.x is fine, I think, we can leave it alone inside docs to de-clutter a bit.
With 1.x as an .md file, it is not any better:
https://git.drupalcode.org/project/slick/blob/8.x-1.x/README.md#features
https://git.drupalcode.org/project/slick/blob/8.x-1.x/README.md#known-is...
It is now harder to read than before.
Perhaps if you have time later, not necessarily now, you may want to reformat the texts with the correct markdowns as well.
Comment #8
gausarts commented2.x was already correct, I think:
There are still .txt references at 2.x, but they are mostly not referenced by functions. We can correct it later as well, but not crucial. We must skip the CHANGELOG.txt part, of course.
Comment #9
thallesFollow fix in references.
Comment #10
gausarts commentedThank you!
One left over, perhaps:
https://git.drupalcode.org/project/slick/blob/8.x-1.x/src/Plugin/Field/R...
Consider renaming it as well?
feel free to commit it once the last file is renamed. Thanks again!
Comment #11
thallesBut gitlab shows readme.md automatically.
Comment #12
gausarts commentedIt is still .txt for the last mentioned file at 1.x branch:
https://git.drupalcode.org/project/slick/blob/8.x-1.x/src/Plugin/Field/R...
Comment #13
thallesDone!
Comment #15
thallesThanks for your help @gausarts!
Fixed!
Comment #16
gausarts commentedMy pleasure, but I do thank you ;)
Comment #17
thallesWhat do you think of putting a readme.md in the root just to reference the docs directory with links, in branch 2.x?
Comment #18
gausarts commentedI would prefer keeping it inside docs simply to de-clutter for now unless you have a compelling reason, of course.
Comment #19
thallesI think the project page with visible documentation is cool, but that's all.