openstack-doc-tools/sitemap
Anne Gentle b4f43bdcaa Update sitemap generator
- Removes grizzly, adds juno
- Removes /api/ just like /trunk/ now that <service>-api repos have moved
to openstack-attic

Change-Id: I4b5dea2379d58b3ed506f70c4a9539a64f892f8e
2015-02-13 23:46:09 -06:00
..
generator Update sitemap generator 2015-02-13 23:46:09 -06:00
README.md script to generate the sitemap.xml for docs.openstack.org 2014-05-29 01:29:18 +02:00
scrapy.cfg script to generate the sitemap.xml for docs.openstack.org 2014-05-29 01:29:18 +02:00
transform-sitemap.xslt Updates sitemap.xml for havana release links 2013-10-21 18:46:55 -05:00

= Sitemap Generator

This script crawls all available sites on http://docs.openstack.org and extracts all URLs. Based on the URLs the script generates a sitemap for search engines according to the protocol described at http://www.sitemaps.org/protocol.html.

== Usage

To generate a new sitemap file simply run the spider using the following command. It will take several minutes to crawl all available sites on http://docs.openstack.org. The result will be available in the file sitemap_docs.openstack.org.xml.

$ scrapy crawl sitemap

It's also possible to crawl other sites using the attribute domain.

For example to crawl http://developer.openstack.org use the following command. The result will be available in the file sitemap_developer.openstack.org.xml.

$ scrapy crawl sitemap -a domain=developer.openstack.org

To write log messages into a file append the parameter -s LOG_FILE=scrapy.log.

== Dependencies

To install the needed modules you can use pip or the package management system included in your distribution. When using the package management system maybe the name of the packages differ. When using pip it's maybe necessary to install some development packages.

$ pip install scrapy