From 9a74c987eea8a6b770656f9152e629a69fdee19a Mon Sep 17 00:00:00 2001 From: rzmk <30333942+rzmk@users.noreply.github.com> Date: Tue, 14 Oct 2025 06:13:55 -0400 Subject: [PATCH] docs: add user-friendly README changes for new developers (#10, #11) --- README.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 339fbe1..604db22 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,33 @@ # ckan-devstaller -`ckan-devstaller` attempts to install CKAN 2.11.3 from source using [ckan-compose](https://github.com/tino097/ckan-compose), intended for development use in a new Ubuntu 22.04 instance. +`ckan-devstaller` attempts to install a CKAN instance using [ckan-compose](https://github.com/tino097/ckan-compose) for development usage in a new Ubuntu 22.04 instance. -Get started at [ckan-devstaller.dathere.com](https://ckan-devstaller.dathere.com). +You may find `ckan-devstaller` useful for: -## Quick start +- Exploring CKAN for the first time without spending hours on installation steps +- Developing/Testing CKAN extensions and fixing bugs +- Trying a new CKAN version to test an upgrade from a legacy version -Please visit [ckan-devstaller.dathere.com/docs/quick-start](https://ckan-devstaller.dathere.com/docs/quick-start) for how to get started with ckan-devstaller. +`ckan-devstaller` was made to help speed up the installation time for CKAN and various extensions/features to boost development productivity. -## Demos +**Get started at [ckan-devstaller.dathere.com](https://ckan-devstaller.dathere.com).** + +## Learn more about developing with CKAN + +You may find the following guides useful while developing with CKAN: + +- [CKAN Hardware Requirements](https://github.com/ckan/ckan/wiki/Hardware-Requirements) - Learn what you need before installing CKAN +- [CKAN Sysadmin guide](https://docs.ckan.org/en/latest/sysadmin-guide.html) - Useful for CKAN instance administrators/sysadmins +- [CKAN Theming guide](https://docs.ckan.org/en/latest/theming/index.html) - Explore how to set up custom themes for your CKAN instance +- [CKAN Extending guide](https://docs.ckan.org/en/latest/extensions/index.html) - Develop CKAN extensions that can enhance your CKAN instance's functionality and add custom features + +## What next? + +- [Customize your config file](https://docs.ckan.org/en/latest/extensions/index.html) +- [Create test data](https://docs.ckan.org/en/latest/maintaining/getting-started.html#creating-test-data) +- [Visit ckan.org](https://ckan.org) + +## `ckan-devstaller` demos ### Interactive customizable installation