The readme file we currently have has Todo in the introduction. We should either remove the section or write an actual todo.

CommentFileSizeAuthor
#3 3054544-3.facets.Add-an-introduction-to-the-readmetxt.patch6.33 KBGogowitsch
#3 interdiff.3054544.2-3.txt4.86 KBGogowitsch
#2 facets-d8-fixreadme-3054544-2.patch2.39 KBvolkswagenchick
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

borisson_ created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Kanopi Studios commented
Component: Code » Documentation
Priority: Normal » Minor
Status: Active » Needs review
FileSize
facets-d8-fixreadme-3054544-2.patch2.39 KB

I uploaded a patch for the README file.

I used the following documentation guidelines:
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Replaced "todo" with a description in the introduction section
Install link was to D7
Added a maintainers section
Added a recommended module section

As per formatting guidelines:
Added a line after headings for readability

Gogowitsch’s picture

Gogowitsch CreditAttribution: Gogowitsch as a volunteer and at QuoData GmbH Quality & Statistics for ÖQUASTA commented
FileSize
interdiff.3054544.2-3.txt4.86 KB
3054544-3.facets.Add-an-introduction-to-the-readmetxt.patch6.33 KB

Thanks @volkswagenchick, all your changes look good!

Changes since the last patch:

  • Wrote “Facets” instead of “Facet” to match facets.info.yml file and machine name.
  • Capitalized Drupal
  • Improved punctuation
  • Re-wrapped lines that were longer than 80 characters
  • Improved spelling
borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
CreditAttribution: borisson_ as a volunteer and at Calibrate commented
Status: Needs review » Reviewed & tested by the community

All of that looks very good indeed. Thanks!

  • borisson_ committed 4b9e705 on 8.x-1.x authored by Gogowitsch 
    Issue #3054544 by Gogowitsch, volkswagenchick: Add an introduction to...
borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
CreditAttribution: borisson_ as a volunteer and at Calibrate commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed, thanks!

Status: Fixed » Closed (fixed)

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