Problem/Motivation

While getting prepared for DrupalCon Easy Out of the box Initiative day and evaluating different layout builder extensions, I noticed the repository had a README, but it lacked helpful links and a configuration section.

According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....

Proposed resolution

Provide a README which follows the following template:
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Adding NorthAmerica2021 tag for visbility.

DrupalCon NA is April 12-16 with a focus on EOOTB on Wednesday, April 14.
Thanks

CommentFileSizeAuthor
#6 layout_builder_kit-3208018-6.patch2.97 KBWebbeh
#6 layout_builder_kit-3208018-interdiff-5-6.txt3.59 KBWebbeh
#5 layout_builder_kit-3208018-4.patch1.57 KBmarcusvsouza

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Issue tags: +Easy Out of the Box, +Novice

Adding the Easy Out of the Box tags for visibility during DrupalCon since this module is used in conjunction with Layout Builder.

After DrupalCon, I'll remove the Easy Out of the Box, thanks!

Thanks.

I am asking politely that this issue be reserved for Novices during DrupalCon NA.

marcusvsouza’s picture

marcusvsouza commented
Assigned: Unassigned » marcusvsouza

I will work on it.

aangel’s picture

aangel commented

Happy to keep this reserved.

marcusvsouza’s picture

marcusvsouza commented
Status: Active » Needs review
StatusFileSize
new layout_builder_kit-3208018-4.patch1.57 KB

Added Introduction, requirements and configuration section to the README file.

Webbeh’s picture

Webbeh
he/him/his
Location Georgia, USA
commented
Assigned: marcusvsouza » Unassigned
StatusFileSize
new layout_builder_kit-3208018-interdiff-5-6.txt3.59 KB
new layout_builder_kit-3208018-6.patch2.97 KB

Updated patch #5 to clean up some of the copy (removed double listing of the components, standardized install script).

One big Q I have is whether the documentation linked should be migrated or replicated on d.org.

marcusvsouza’s picture

marcusvsouza commented
Status: Needs review » Reviewed & tested by the community

Revised! Patch applies good, and the Readme have the required pattern!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented

My only comment would be to replace the work click with select, as not everyone uses a mouse.

alvarito75’s picture

alvarito75 commented
Status: Reviewed & tested by the community » Fixed

Thanks everyone for helping

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.