GSA/datagov-wptheme

Provide CKAN API documentation for catalog.data.gov

Open

#180 opened on Nov 23, 2013

View on GitHub
 (8 comments) (0 reactions) (1 assignee)JavaScript (1,889 stars) (457 forks)batch import
apicontentdevelopershelp wanted

Description

This should be featured in the developer section and you can refer to http://www.healthdata.gov/catalog-api as an example

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
CKAN API knowledgeDocumentation writing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the existing developer section at catalog.data.gov for current structure. Examine the example at http://www.healthdata.gov/catalog api to understand the expected format. Check the issue comments for any additional requirements or feedback. Then create a new documentation page following the example, covering CKAN API endpoints and usage.