Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update 'Common CKAN Administrator Tasks' docs for 2.0 #533

Closed
seanh opened this issue Mar 1, 2013 · 1 comment · Fixed by #692
Closed

Update 'Common CKAN Administrator Tasks' docs for 2.0 #533

seanh opened this issue Mar 1, 2013 · 1 comment · Fixed by #692
Assignees
Milestone

Comments

@seanh
Copy link
Contributor

seanh commented Mar 1, 2013

A few things on this page are out of date, e.g. they refer to the old auth system: http://docs.ckan.org/en/latest/paster.html

Some new paster commands aren't documented.

Should the paster commands docs be pulled from docstrings by autodoc like the api and plugin interfaces docs are? Seems a better way to keep them up to date and not have to write the docs twice

Everything on this page seems to be paster commands, so should the page be renamed CKAN Paster Commands? The current title is a bit generic

This Database Dumps page is also just about a couple of paster commands, so maybe belongs on the same page with the rest of the paster commands now on its own page

@ghost ghost assigned vitorbaptista Mar 14, 2013
@seanh
Copy link
Contributor Author

seanh commented Mar 14, 2013

@vitorbaptista Assigning this one to you. Can you try and make it pull the docs out of the source using autodoc? This is already done for the plugin interfaces and action API Ask me if you need any guidance. We're hoping to get these done by end of next week so we can release 2.0 in a couple of weeks

vitorbaptista added a commit that referenced this issue Apr 15, 2013
In paster's documentation, a required field is shown in UPPER_CASE, and
underscores are used as word separator.

Conflicts:

	ckan/lib/cli.py
vitorbaptista added a commit that referenced this issue Apr 15, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants