Currently, the module page only contains information for the Drupal 7 release. We should add further installation / usage information on the module page for the 8.x-2.x release.
Add further installation / usage information on the module page for the 8.x-2.x release.
Also the other supported / recommended versions should be described and by their porpose, plan & differences.
Example for the module page:
Show commandsStart within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
changes
Comments
Comment #2
anybodyIndeed, the module page seems to target 7.x and is confusing for Drupal 8, which may be more relevant due to EOL.
Comment #3
anybodyComment #4
anybodyComment #5
anybodyAdded the template for the module page to copy & paste HTML (edit) after review.
Comment #6
anybodyComment #7
grevil commentedLooks good! I would add "Drupal 9/10 support" for 3.x. Everything else looks fine
Comment #8
anybodyThanks, I'll copy that over.
Comment #9
anybodyAs I can see, you already did :) Thanks!
Comment #10
grevil commentedAlso, I removed "Added field items wrapper & further functionality", because future functionalities can be seen in the current update change. Otherwise, we always have to add newly added functionalities to the module page.
Now only the readme needs to be reworked.
Comment #12
grevil commentedI created a simple README.md, @Anybody should we include more detailed information on how to use this module? Or is the current implementation enough?
Comment #13
anybody@Grevil better than nothing already! :D
I think you should create a best practice structure, perhaps there's a template at Drupal.org or you can have a look at very well maintained and much used modules.
Then fill in the current / additional content which helps users starting with fences from scratch.
Afterwards, I think it would be best if @thomas.frobieter makes final changes from a typical Drupal Designer's perspective.
Let's only do this for 3.x so far... For 7.x I'm still unsure about the difference between 1.x and 2.x and which one to use for the future ;)
Comment #14
grevil commentedComment #15
anybodyOnly 3.x is available now. All other versions have been deprecated. So we should update the module page and README.md to document the current state and fine!
Comment #17
lrwebks commentedComment #18
anybody@lrwebks please finally add a paragraph about fences presets, like on the module page.
Then ensure the module description has everything important and we're done!
Comment #19
lrwebks commentedI'm really not sure why, but after hitting “Update Fork”, for some reason GitLab treats those merged commits as separate commits made on this branch, which clutters things up a bit in the MR…
Regardless, I have added the section about fences presets and made sure that the introduction covers all the necessary info that was present in @grevil's README, just compressed down a bit to the essential info.
Also, PHPUnit failure is unrelated.
Comment #20
anybody@lrwebks the wrong branch had been selected. Needs to be 3.x but 8.x-2.x was selected.
Comment #21
anybody@lrwebks did you update the module page?
Comment #22
lrwebks commentedRe #20: I see! That's probably why Drupal Core is about to introduce a main branch instead of many
version.xbranches (I personally get the reason for version branches, but I still find them to be very confusing sometimes)Re #21: I did not and cannot because I'm not a maintainer.
Comment #23
anybody@lrwebks sorry I made you maintainer and already updated the module page.
Comment #25
anybody