- Közintézmény
CKAN Documentation
CKAN szoftver dokumentáció és útmutatók.
Bemutatkozás
A CKAN dokumentáció több útmutatóra van szervezve, amelyek különböző célközönségeket szolgálnak ki, beleértve a felhasználói útmutatót, a rendszergazdai útmutatót, a karbantartói útmutatót, az API útmutatót, a kiterjesztési útmutatót, a tematikai útmutatót és a közreműködési útmutatót. A dokumentáció lefedi a CKAN alapvető funkcióit, mint például a fióklétrehozás, a szervezetek és adatkészletek kezelése, valamint a telepítési és frissítési eljárások. Részletezi továbbá az API kérések elkészítését, az API tokenek hitelesítését, valamint az API funkciók referenciáit. A kiterjesztések írásához útmutatást nyújt a plugin felületekről, tesztelésről és legjobb gyakorlatokról. A dokumentációt a CKAN fejlesztőcsapata tartja fenn, és szabad és nyílt forráskódú szoftverként (Creative Commons Attribution ShareAlike v3.0 License alatt) közreműködéseket fogad el.
Szolgáltatások, tevékenységek
- User guide
- Sysadmin guide
- Maintainer’s guide
- API guide
- Extending guide
- Theming guide
- Contributing guide
- Changelog
- Overview
- Creating a sysadmin account
- Customizing look and feel
- Managing organizations and datasets
- Permanently deleting datasets, organizations and groups
- Managing users
- CKAN releases
- Installing CKAN
- Upgrading CKAN
- Getting started
- Database Management
- Command Line Interface (CLI)
- Organizations and authorization
- Data preview and visualization
- FileStore and file uploads
- DataStore extension
- Table Designer extension
- Apps & Ideas
- Tag Vocabularies
- Form Integration
- Linked Data and RDF
- Background jobs
- Email notifications
- Page View Tracking
- Multilingual Extension
- Stats Extension
- Configuration Options
- Making an API request
- Example: Importing datasets with the CKAN API
- API versions
- Authentication and API tokens
- GET-able API functions
- JSONP support
- API Examples
- Action API reference
- Writing extensions tutorial
- Using custom config settings in extensions
- Making configuration options runtime-editable
- Testing extensions
- Best practices for writing extensions
- Customizing dataset and resource metadata fields using IDatasetForm
- Plugin interfaces reference
- Plugins toolkit reference
- Validator functions reference
- Internationalizing strings in extensions
- Migration from Pylons to Flask
- Signals
- Customizing the DataStore Data Dictionary Form
- Customizing Table Designer Column Types and Constraints
- Customizing CKAN’s templates
- Adding static files
- Customizing CKAN’s CSS
- Adding CSS and JavaScript files using Webassets
- Customizing CKAN’s JavaScript
- Creating dynamic user interfaces with htmx
- Best practices for writing CKAN themes
- Custom Jinja2 tags reference
- Variables and functions available to templates
- Objects and methods available to JavaScript modules
- Template helper functions reference
- Template snippets reference
- JavaScript sandbox reference
- JavaScript API client reference
- CKAN jQuery plugins reference
- Reporting issues
- Translating CKAN
- Testing CKAN
- Writing commit messages
- Making a pull request
- Reviewing and merging a pull request
- Writing documentation
- Projects for beginner CKAN developers
- CKAN code architecture
- CSS coding standards
- HTML coding standards
- JavaScript coding standards
- Python coding standards
- String internationalization
- Unicode handling
- Testing coding standards
- Frontend development guidelines
- Database migrations
- Upgrading CKAN’s dependencies
- Doing a CKAN release
- Maintenance tools