{"id":22302653,"url":"https://github.com/dataoneorg/indexer_documentation","last_synced_at":"2025-03-26T00:28:18.179Z","repository":{"id":74058818,"uuid":"69567444","full_name":"DataONEorg/indexer_documentation","owner":"DataONEorg","description":"Auto-generated documentation for the DataONE CN content indexer.","archived":false,"fork":false,"pushed_at":"2020-08-07T12:11:42.000Z","size":391,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-30T21:17:16.781Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DataONEorg.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-09-29T12:56:48.000Z","updated_at":"2020-08-07T12:11:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"4fe0005e-18b7-42e3-9be0-b6132ba8a0c4","html_url":"https://github.com/DataONEorg/indexer_documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataONEorg%2Findexer_documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataONEorg%2Findexer_documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataONEorg%2Findexer_documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataONEorg%2Findexer_documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DataONEorg","download_url":"https://codeload.github.com/DataONEorg/indexer_documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245565121,"owners_count":20636248,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation"],"created_at":"2024-12-03T18:40:35.235Z","updated_at":"2025-03-26T00:28:18.114Z","avatar_url":"https://github.com/DataONEorg.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"README for indexer_documentation\n================================\n\nGenerates `indexer-documentation.rtfd.io`_ documentation from d1_cn_index_processor_.\n\nThis 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.\n\nTo generate the documentation from a fresh checkout::\n\n  cd indexer_documentation\n  make initialize\n  make generate\n  make html\n\nGenerated documents are available for viewing at `indexer-documentation.rtfd.io`_ after pushing changes to GitHub.\n\nDependencies\n------------\n\nDocumentation is generated by Sphinx_ and the sphinx-better-theme_, both of which can be installed using pip_::\n\n  pip install -U sphinx\n  pip install -U sphinx-better-theme\n\n.. _indexer-documentation.rtfd.io: http://indexer-documentation.rtfd.io\n.. _d1_cn_index_processor: https://repository.dataone.org/software/cicore/trunk/cn/d1_cn_index_processor/\n.. _sphinx: http://www.sphinx-doc.org/en/stable/\n.. _sphinx-better-theme: https://pypi.python.org/pypi/sphinx-better-theme\n.. _pip: https://pypi.python.org/pypi/pip\n\n\nNotes\n-----\n\nField descriptions YAML file can be created with::\n\n  curl \"https://cn.dataone.org/cn/v2/query/solr\" | \\\n  xml sel -t -m \"//queryField\" -v \"name\" -o \": \\\"\" -v \"description\" -o \"\\\"\" -n \u003e solr_field_descriptions.yaml\n\nList of processor beans::\n\n  for f in *.xml; do \\\n  xml sel -N b=\"http://www.springframework.org/schema/beans\" -t -m \"//b:bean[contains(@id, 'Subprocessor')]\" -v \"@id\" -n $f; \\\n  done | sort\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdataoneorg%2Findexer_documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdataoneorg%2Findexer_documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdataoneorg%2Findexer_documentation/lists"}