From 88f9356b2f0bde87ae2126c82ff436b854dff7a2 Mon Sep 17 00:00:00 2001 From: Ian Ward Date: Wed, 9 Oct 2024 15:21:38 -0400 Subject: [PATCH] fix example extension ownership command, remove image --- README.md | 23 ++++++++++++++++++++--- src/.placeholder | 0 2 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 src/.placeholder diff --git a/README.md b/README.md index 3d9c7dd6a..ab781e93a 100644 --- a/README.md +++ b/README.md @@ -113,12 +113,29 @@ See [CKAN images](#5-ckan-images) for more details of what happens when using de You can use the ckan [extension](https://docs.ckan.org/en/latest/extensions/tutorial.html#creating-a-new-extension) instructions to create a CKAN extension, only executing the command inside the CKAN container and setting the mounted `src/` folder as output: - docker compose -f docker-compose.dev.yml exec ckan-dev /bin/sh -c "ckan -c /srv/app/ckan.ini generate extension --output-dir /srv/app/src_extensions" +```bash +docker compose -f docker-compose.dev.yml exec ckan-dev ckan generate extension --output-dir /srv/app/src_extensions +``` -![Screenshot 2023-02-22 at 1 45 55 pm](https://user-images.githubusercontent.com/54408245/220623568-b4e074c7-6d07-4d27-ae29-35ce70961463.png) +``` +Extension's name [must begin 'ckanext-']: ckanext-mytheme +Author's name []: Joe Bloggs +Author's email []: joeb@example.com +Your Github user or organization name []: example +Brief description of the project []: My CKAN theme +List of keywords (separated by spaces) [CKAN]: +Do you want to include code examples? [y/N]: y + +Written: /srv/app/src_extensions/ckanext-mytheme +``` +The new extension files and directories are created in the `/srv/app/src_extensions/` folder in the running container. They will also exist in the local src/ directory as local `/src` directory is mounted as `/srv/app/src_extensions/` on the ckan container. -The new extension files and directories are created in the `/srv/app/src_extensions/` folder in the running container. They will also exist in the local src/ directory as local `/src` directory is mounted as `/srv/app/src_extensions/` on the ckan container. You might need to change the owner of its folder to have the appropiate permissions. +The files will be owned by root, to correct the ownership so you can edit the files with your normal account outside the container run: + +```bash +docker compose -f docker-compose.dev.yml exec ckan-dev chown --reference /srv/app/src_extensions/ -R /srv/app/src_extensions/ckanext-mytheme/ +``` #### Running HTTPS on development mode diff --git a/src/.placeholder b/src/.placeholder new file mode 100644 index 000000000..e69de29bb