This repository includes information about metadata practices at the Inter-university Consortium for Political and Social Research (ICPSR).
- ICPSR Metadata Documentation Portal
- JSON Schema (machine actionable) version of the ICPSR Metadata Schema.
If new content will be added to the ICPSR Metadata Documentation Portal:
- Create a new repository branch from
main(if working from the command line, make sure your localmainis up to date by first runninggit pull). - Edit the JSON Schema or YAML files (if making changes to the metadata schema itself) or edit/create markdown files in the Markdown folder (if making changes to other metadata documentation). [1]
- If new markdown pages have been added, they must be included in the "nav" section of the mkdocs.yaml configuration file so that they will appear in the documentation portal's navigation. Each "nav" entry must include a page title and the path to the markdown file (relative to the Markdown folder), as illustrated below:
[2] - Commit your changes and push to the remote repository. If the JSON Schema or any YAML file has been modified, this will trigger an automated GitHub Actions workflow that will generate a new markdown copy of the ICPSR Metadata Schema.
- When all edits are complete, submit a pull request and assign it to a repository member with the appropriate permissions.
- Once the pull request is confirmed, an automated GitHub Actions workflow will be triggered, which:
- Produces a new HTML version of the ICPSR Metadata Documentation Portal
- Pushes the HTML files to the
gh-pagesrepository branch, where they are made publicly accessible in the Documentation Portal] as soon as the workflow is completed.
- Check the GitHub "Actions" tab to see the workflow progress (and any error messages, should an issue arise).
[1] For information on creating markdown documents, see the Markdown Guide.
[2] For more information on MkDocs (and the readthedocs theme), see the project website.