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

CommentFileSizeAuthor
#10 xmlsitemap_node-add-readme-2832818-10.patch2.82 KBvolkswagenchick
#9 After-2.png22.93 KBkrina.addweb
#6 xmlsitemap_node-add-readme-2835785-6.patch2.87 KBvolkswagenchick
#6 interdiff-2832818-2-6.txt2.14 KBvolkswagenchick
#2 xmlsitemap_node-add-readme-2832818-2.patch2.82 KBvolkswagenchick
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Version: 7.x-2.3 » 7.x-2.0
Assigned: volkswagenchick » Unassigned
Status: Active » Needs review
FileSize
xmlsitemap_node-add-readme-2832818-2.patch2.82 KB

Here's a patch which includes a README.txt file.
thanks!

Kristen Pol’s picture

Kristen Pol
she/her
Primary language English
Location Santa Cruz, CA, USA
CreditAttribution: Kristen Pol at Hook 42 commented

Thanks for the patch.

  1. +++ b/xmlsitemap_node/README.txt
@@ -0,0 +1,68 @@
+* This is a submodule of the Xml sitemap module. Install the Xml sitemap module as you would normally install a contributed Drupal module. See https://drupal.org/documentation/install/modules-themes/modules-7 for further information.

    I see XML sitemap used in some places and Xml sitemap in others. Check the module info file for the correct module name for use in the readme. 

  2. +++ b/xmlsitemap_node/README.txt
@@ -0,0 +1,68 @@
+1. Install the Xml sitemap module.
+2. Enable the Xml sitemap module.
+3. To include nodes in the sitemap, enable the XML sitemap node submodule.
+4. To add nodes to the sitemap, visit the Edit page of the Content Type which you want to appear on the sitemap.
+5. Click on the Xml sitemap horizontal tab.
+6. Under "Inclusion" change "Excluded" to become "Included".  Click Save.
+7. If enabled, all content of the specific node type will be included.  Individual nodes can be excluded on their specific node edit page.
+8. Once that is all complete, go to Configurations --> Search and Metadata --> XML sitemap.
+9. Click on the Rebuild Links tab in the upper right.
+10. Click on "Rebuild sitemap" even if the message says that you do not need to.
+11. Now you're taken back to the config page which shows you the link to your Xml sitemap which you can click and confirm that pages have been added.

    See above re use of Xml sitemap.

Kristen Pol’s picture

Kristen Pol
she/her
Primary language English
Location Santa Cruz, CA, USA
CreditAttribution: Kristen Pol at Hook 42 commented

One more nitpick:

+++ b/xmlsitemap_node/README.txt
@@ -0,0 +1,68 @@
+6. Under "Inclusion" change "Excluded" to become "Included".  Click Save.
+7. If enabled, all content of the specific node type will be included.  Individual nodes can be excluded on their specific node edit page.

Use single space between sentences.

Kristen Pol’s picture

Kristen Pol
she/her
Primary language English
Location Santa Cruz, CA, USA
CreditAttribution: Kristen Pol at Hook 42 commented
Status: Needs review » Needs work
volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
FileSize
interdiff-2832818-2-6.txt2.14 KB
xmlsitemap_node-add-readme-2835785-6.patch2.87 KB

Thanks Kristen Pol!

Here is a new patch and an interdiff.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Status: Needs work » Needs review
krina.addweb’s picture

krina.addweb CreditAttribution: krina.addweb at AddWeb Solution Pvt. Ltd. commented
Status: Needs review » Reviewed & tested by the community
FileSize
After-2.png22.93 KB

Thanks! @volkswagenchick for the patch, it works well.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Status: Reviewed & tested by the community » Needs review
FileSize
xmlsitemap_node-add-readme-2832818-10.patch2.82 KB

I have since learned more about documentation standards since first working on this README. I have updated the README to address formatting issues and I replaced a node alias with a permalink.

genevieveparker’s picture

genevieveparker CreditAttribution: genevieveparker at Hook 42 commented
Status: Needs review » Reviewed & tested by the community

looks good

renatog’s picture

renatog
Location Campinas
CreditAttribution: renatog at CI&T commented

#10 works good for me.

Thank you very much for contributions.

renatog’s picture

renatog
Location Campinas
CreditAttribution: renatog at CI&T commented
Status: Reviewed & tested by the community » Fixed

Fixed.

Committed to the dev branch.

Thanks.

Regards.

Status: Fixed » Closed (fixed)

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