https://github.com/dataoneorg/indexer_documentation
Auto-generated documentation for the DataONE CN content indexer.
https://github.com/dataoneorg/indexer_documentation
documentation
Last synced: over 1 year ago
JSON representation
Auto-generated documentation for the DataONE CN content indexer.
- Host: GitHub
- URL: https://github.com/dataoneorg/indexer_documentation
- Owner: DataONEorg
- Created: 2016-09-29T12:56:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-07T12:11:42.000Z (almost 6 years ago)
- Last Synced: 2025-01-30T21:17:16.781Z (over 1 year ago)
- Topics: documentation
- Language: Python
- Size: 382 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
README for indexer_documentation
================================
Generates `indexer-documentation.rtfd.io`_ documentation from d1_cn_index_processor_.
This script generates documentation for the DataONE index processor, describing the mapping from source metadata to solr index fields. It does this by examining the java bean definitions being used for different metadata formats and generating restructured text documentation showing how solr fields are populated from different content types.
To generate the documentation from a fresh checkout::
cd indexer_documentation
make initialize
make generate
make html
Generated documents are available for viewing at `indexer-documentation.rtfd.io`_ after pushing changes to GitHub.
Dependencies
------------
Documentation is generated by Sphinx_ and the sphinx-better-theme_, both of which can be installed using pip_::
pip install -U sphinx
pip install -U sphinx-better-theme
.. _indexer-documentation.rtfd.io: http://indexer-documentation.rtfd.io
.. _d1_cn_index_processor: https://repository.dataone.org/software/cicore/trunk/cn/d1_cn_index_processor/
.. _sphinx: http://www.sphinx-doc.org/en/stable/
.. _sphinx-better-theme: https://pypi.python.org/pypi/sphinx-better-theme
.. _pip: https://pypi.python.org/pypi/pip
Notes
-----
Field descriptions YAML file can be created with::
curl "https://cn.dataone.org/cn/v2/query/solr" | \
xml sel -t -m "//queryField" -v "name" -o ": \"" -v "description" -o "\"" -n > solr_field_descriptions.yaml
List of processor beans::
for f in *.xml; do \
xml sel -N b="http://www.springframework.org/schema/beans" -t -m "//b:bean[contains(@id, 'Subprocessor')]" -v "@id" -n $f; \
done | sort