README.txt needs slight revision [#1799960]

Simplenews 7.x-1.0 README.txt, lines 49 and 50 read as: Structure > Web Services > Newsletters >Add newsletter category and Structure > Web Services > Newsletters > edit newsletter category, respectively. This is not quite correct and confuses novices like me. These two lines should both begin as: Configuration > Web Services > ... instead. This change will bring the README.txt file into agreement with the Simplenews Handbook and other published directions for the module.

Comment	File	Size	Author
#11	1799960-readme.png	155.8 KB	kleiton_rodrigues
#9	1799960-9.patch	927 bytes	Webbeh
#9	7.x-1.x: PHP 5.4 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks
#9	interdiff-1799960-3-9.txt	534 bytes	Webbeh
#3	simplenews-READMETXT_slight_changes-1799960-3.patch	1.21 KB	bhide.nishad
#3	7.x-1.x: PHP 5.4 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

pvdpdrop CreditAttribution: pvdpdrop as a volunteer commented 19 March 2016 at 10:21

Issue summary:

View changes

This is still the case in Simplenews 7.x-1.1

Comment #2

bhide.nishad CreditAttribution: bhide.nishad at Clarion Technologies commented 26 April 2016 at 12:20

Assigned:

Unassigned

» bhide.nishad

Working...

Comment #3

bhide.nishad CreditAttribution: bhide.nishad at Clarion Technologies commented 26 April 2016 at 13:09

Assigned:	bhide.nishad	» Unassigned
Status:	Active	» Needs review

File	Size
simplenews-READMETXT_slight_changes-1799960-3.patch	1.21 KB
7.x-1.x: PHP 5.4 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks

Please find the attached patch with updated menu paths in documentation (README), as requested.

Comment #4

guru.e CreditAttribution: guru.e at Kiluvai Tech Solutions Private Limited commented 30 July 2016 at 13:55

As I have checked, now I can easily able to understand the steps.

But my suggestion is we need to change the line "Structure > Content types > Newsletter issue (edit) > Publishing Option" .

Because I cannot able to understand the line. The word Newsletter issue (edit) is not understandable. If the word changed to "Content type name" means that would be better. Please let us know about your opinions.

Comment #5

bhide.nishad CreditAttribution: bhide.nishad at Clarion Technologies commented 1 August 2016 at 06:15

@guru.e,

Thanks for reviewing the changes.
Instead of Machine names, Human readable names and steps has been used in Readme.txt

The steps "Structure > Content types > Newsletter issue (edit) > Publishing Option", conveys the user to enable the Publishing option.
As content type is already created during enabling the module, user need to edit the Newsletter issue content type to enable the above mentioned option.

Let me know your thoughts, and what should be the replacement string.

Thanks,
Nishad

Comment #6

TR CreditAttribution: TR commented 8 May 2019 at 02:28

Version:	7.x-1.0	» 7.x-1.x-dev
Category:	Support request	» Bug report

Comment #7

i-trokhanenko

Lutsk 🇺🇦

CreditAttribution: i-trokhanenko at RockSolid PSF commented 11 May 2019 at 09:40

Status:

Needs review

» Needs work

Hello
I propose to change README.txt file to README.md to have a better view and format in gitlab interface for the README files in source code.
because if we have a look at the following link https://git.drupalcode.org/project/simplenews We will notice the nice gitlab interface :)
But we could make the project code even more readable with the .md files. README.md will be nice.

also, @FredMart can you use the next time the Issue Summary Template?

Comment #8

TR CreditAttribution: TR commented 11 May 2019 at 19:09

Status:

Needs work

» Needs review

This is a SEVEN YEAR OLD issue about wrong information in README.txt. That wrong information should be fixed and that fix should not be blocked by other unrelated things.

Moving from README.txt to README.md should be a "Feature request", and it should be a separate issue. We have just recently in the past month moved to GitLab and Drupal as yet has no standards for using or formatting a README.md. If you would like to provide a patch to add a README.md then please do so in a new issue, but simply making the request without a patch isn't helpful because it should be obvious that the D7 branch of this module hasn't been getting any attention - no one is going to do the work for you ...

From the documentation you linked to:

Issue summaries need to be written if the issue has more than a few comments and/or an average developer cannot understand the subject matter after a few minutes of study.

Use of the issue summary template has never been mandatory, and is unnecessary when the issue is as simple and straightforward as this. Adding additional hoops for contributors to jump through doesn't serve to improve the code ...

Comment #9

Webbeh

he/him/his

Georgia, USA

CreditAttribution: Webbeh at Georgia Institute of Technology commented 17 February 2020 at 20:58

File	Size
interdiff-1799960-3-9.txt	534 bytes
1799960-9.patch	927 bytes
7.x-1.x: PHP 5.4 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks

Took the work of #5 and massaged the wording to note the setting change, as I think we want to provide as many breadcrumbs to help guide users along on this.