obsolete text in README

Removed Drush section from ReadMe. Please review.

hi @Romisha

Thanks for submitting the patch, but since we are removing all the examples of drush command we should remove the references of drush commands from readme file.

like
> Content export works with a set of drush commands

and

> Generate a hal+json file for each entity to be exported using the drush commands described below.

Please review the updated patch.

In line 25 are saying that it can be exported using the drush command, is it not necessary to remove it too?

* Easily export your content and its dependencies to yml using drush commands

I'm leaving a patch without the line mentioned in comment #7 for evaluation

+++ b/README.md
@@ -14,7 +14,7 @@
+[Default Content][1] allows you to export content along with site configuration information. It does so by leveraging core's serialization and hal modules. It supports entity-references between content as well as files if you have File entity. Content import happens automatically as part of site installation. The import process scans all modules and imports any content found that is located in the expected file path and using the expected .json file structure. (See detailed information below)

There should be a hard break at 80 characters according to drupal documentation standards. Please visit https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

To the patch submitted in #8, I just manually word-wrapped the text within around 80 cols as per drupal documentation standards. Please review.

Hi,
Headings underlined with ===/--- to the length of the heading, followed by a blank line.
According to https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

 ## Introduction
 _A default content solution for Drupal 8_

 ### Additional Information
 * For a full description of the module, visit the project page:

and other places

Hello @nitvirus, thank you for reviewing.

We are updating README.md file, it uses markdown syntax. Here # chararcters will do the job for us, so I don't think underlining the headings would be necessary.

I have updated the patch accordingly, please review.

Thanks fo the new patch, here are some recommendations.

1. +++ b/README.md
   @@ -1,30 +1,33 @@
   +configeration information. It does so by leveraging core's serialization and
   +hal modules. It supports entity-references between content as well as files if
   

   The Core module names should be capitalized.

2. +++ b/README.md
   @@ -32,26 +35,37 @@ _A default content solution for Drupal 8_
   + will give you the option to enable them.
   

   Is there an empty space before "will"?

3. +++ b/README.md
   @@ -32,26 +35,37 @@ _A default content solution for Drupal 8_
   +following structure: `content/{entity type}/{filename}`, where `{entity type}`
   +will be one of node, taxonomy_term, etc. Filename should be `{entity ID}.json`.
   

   I recommend having hanging indents
   https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Hi volkswagenchick,

Should I create a new patch for these changes, seems like this patch is already in RTBC.

--

My apologies, I marked the issue in the wrong state.

Hey,

I have updated the patch, as per comments.

Core modules are capitalized.
Removed empty space.
Added hanging Indents.

--
Nitish

Some minor cleanup of existing copy.

Removal of todo in README, as it seems pretty out-of-place and better scoped to a drupal.org issue.

Also standardized core capitalizations document-wide, as this was missed on the bottom part of the document.

Added some consistent spacing.

Patch and interdiff attached.

it looks good to me..

@meghasharma Thanks for the review, testing patches is so important to move the projects forward.

I have a suggestion though. Can you indicate what tests you did or what you reviewed?
For example:
"Patch applied locally. I reviewed the file for grammar, spelling. Links work as expected." That helps others to know that the review is complete.
Thanks!
~AmyJune

I'm confused about this. Why are we removing the documentation about the Drush commands?
#6 - @joachim

I'm confused too!

Documentation about the Drush commands was the highlight of the README file for me.

Do they really have to be removed from the README file?

If so, could we include an indication on where users should go to learn which drush commands are available and how to use them?

Marking back to Needs Review per #21. Does the existing community documentation satisfy what you're looking for on this, @bmunslow? https://www.drupal.org/docs/8/modules/default-content-for-d8/overview

Marking back to Needs Review per #21. Does the existing community documentation satisfy what you're looking for on this, @bmunslow? https://www.drupal.org/docs/8/modules/default-content-for-d8/overview

#22 - @Webbeh

Thanks for pointing this out Webbeh.

Existing community documentation, as of today, is complete and helpful regarding the drush commands.

Settings this back to RTBC!

I've recently created the 2.0.x branch, see the project page on all the improvements in that branch. Testing that and providing feedback would be very welcome. The 1.x branch isn't actively maintained anymore.

2.0.x uses a completely different normalization implementation that does not depend on hal.module anymore. I did forget to update the README however. I updated the project page, so if someone wants to work on updating the README based on the project page that would be very welcome.

I'll read the new documenation and add the proper details to the module's README file.

I changed the titles to all caps, and added block to the Maintainers too. Also i reorganized the part where the Drush commands are located, but didn't remove them because of the #6 and #21 comments requirements.

At quick glance these lines have a trailing space or character at the end of them.
Thanks for the patch

+++ b/README.md
@@ -1,30 +1,25 @@
+serialization and hal modules. It supports entity-references between ¶
...
+with a set of drush commands (more on those below). Content import ¶
...
+scans all modules and imports any content found that is located in the ¶

@@ -33,133 +28,130 @@ _A default content solution for Drupal 8_
+Install as you would normally install a contributed Drupal module. ¶
...
+Enable the Default Content module first. Any module that requires ¶
+default content can put hal+json versions of the entities (created ¶
...
+Once your custom module is enabled, the entities you exported will be ¶

-- **required-arguments:** 2
+**WARNING** ¶
...
+Beware of modules that add extra layers of access control (i.e. ¶
+field_permissions and group). By default, drush runs as user anonymous ¶
...
+  $ drush dce taxonomy_term <taxonomy term id> ¶
+  $ drush dce file <file id> ¶
+  $ drush dce media <media id> ¶
+  $ drush dce menu_link_content <menu link id> ¶
+  $ drush dce block_content <block id> ¶

-- **required-arguments:** 1
+- **folder:** Folder to export to, entities are grouped by entity type ¶

I'll erase all the trailing space.

I erased all the extra spaces, anything else?

Hi @vicheldt,

The trailing space or character at the end of the line is now removed.

+++ b/README.md
@@ -12,11 +12,11 @@
 
 The Default Content module allows you to export content along with
 site configuration information. It does so by leveraging core's
-serialization and hal modules. It supports entity-references between 
+serialization and hal modules. It supports entity-references between
 content as well as files if you have File entity. Content export works
-with a set of drush commands (more on those below). Content import 
+with a set of drush commands (more on those below). Content import
 happens automatically as part of site installation. The import process
-scans all modules and imports any content found that is located in the 
+scans all modules and imports any content found that is located in the
 expected file path and using the expected .json file structure. (See
 detailed information below)
 
@@ -34,7 +34,7 @@ This module requires no modules outside of Drupal core.
 
 ## Installation
 
-Install as you would normally install a contributed Drupal module. 
+Install as you would normally install a contributed Drupal module.
 Visit:
 https://www.drupal.org/docs/extending-drupal/installing-modules
 for further information.
@@ -47,8 +47,8 @@ The module has no menu or modifiable settings. There is no configuration.
 
 ## Usage
 
-Enable the Default Content module first. Any module that requires 
-default content can put hal+json versions of the entities (created 
+Enable the Default Content module first. Any module that requires
+default content can put hal+json versions of the entities (created
 with the drush commands) inside content/{entity_type} folders.
 
 Once your custom module is enabled, the entities you exported will be 
@@ -77,10 +77,10 @@ Options:
 - **file:** Write out the exported content to a file instead of stdout
 Aliases: dce
 
-**WARNING** 
+**WARNING**
 
-Beware of modules that add extra layers of access control (i.e. 
-field_permissions and group). By default, drush runs as user anonymous 
+Beware of modules that add extra layers of access control (i.e.
+field_permissions and group). By default, drush runs as user anonymous
 and may not have access to the fields or nodes.
 
 * Examples:
@@ -90,11 +90,11 @@ and may not have access to the fields or nodes.
 
   ```
   $ drush dce node <node id> (e.g., $ drush dce node 123)
-  $ drush dce taxonomy_term <taxonomy term id> 
-  $ drush dce file <file id> 
-  $ drush dce media <media id> 
-  $ drush dce menu_link_content <menu link id> 
-  $ drush dce block_content <block id> 
+  $ drush dce taxonomy_term <taxonomy term id>
+  $ drush dce file <file id>
+  $ drush dce media <media id>
+  $ drush dce menu_link_content <menu link id>
+  $ drush dce block_content <block id>
   ```
 
 #### default-content-export-references
@@ -105,7 +105,7 @@ Arguments:
 - **entity_type:** The entity type to export. (required)
 - **entity_id:** The ID of the entity to export.
 Options:
-- **folder:** Folder to export to, entities are grouped by entity type 
+- **folder:** Folder to export to, entities are grouped by entity type
 into directories.
 Aliases: dcer

+1 RTBC, rebased.

last patch failed to apply but there's MR created (applies cleanly) so it require review

Closed duplicate #3332222: Update README.md file according to README.md template on 2.0.x-dev

Closed another duplicate #3176534: Example commands in README wrong

And one more #3247375: Replace all references to Drupal 8 with Drupal 9 or just Drupal

@kavitha@specbee.com Generally, it is best practice to explain what criteria you used to move the issue into RTBC.
What did you test? Were all comments addressed? Did all the links work as expected, coding standards, clear concise sentences, and so on.

Thanks.

I agree @volkswagenchick. See also #3315968-22: Replace README.txt with README.md where another RTBC was based on the patch applying, and no review of format or content.

Non-review by kavitha@specbee.com deleted as spam.

It seems that the README was updated in other issues, so the MR for this issue no longer applies.

The points mentioned in the issue summary are no longer true: they have been fixed. But at least some text in the MR is probably worth saving. (I do not see anything in the current README about access control.) So I am marking this issue as NW, not Closed (outdated).

One problem I noticed in the current README:

#### Exports an entity and all its referenced entities

##### default-content-export-references

The command is actually drush default-content:export-references.