ckan / ckan/ideas

Consolidated site specific API documentation

Open
#243 0 comments 0 reactions 0 assignees View on GitHub
Topic: Docs
Dominant language
No language data
Stars
39
Forks
1
PR merge metrics
No merged PRs in 30d

Description

By default CKAN has links in various locations to the API documentation located at ckan.org. If functionality of a site has been extended via plugins that information is not readily available. Even documentation for the datastore requires the user to search or browse. I know some extensions may not document their API to the same extent as CKAN, but at least having access to the list of functions would be handy.

Contributor guide

No contributing guide indexed for this repository

Research direction

No files, tests, or entry points are named. Start by locating the various CKAN links to ckan.org API documentation and reviewing how plugin and datastore API information is exposed; done means site-specific documentation provides a consolidated, accessible list of available functions.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.