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

Documentation update #234

Open
wants to merge 6 commits into
base: cioos_dev
Choose a base branch
from
Open

Documentation update #234

wants to merge 6 commits into from

Conversation

sjbruce
Copy link

@sjbruce sjbruce commented Oct 22, 2024

Fixes #

As the ckan project has evolved the original documentation grew increasingly out of sync with the way the CIOOS incarnation of ckan is used and deployed.

The original install document, which covers far more than simply running ckan, has been brought into line with the current version of CKAN as used by CIOOS.

There is still more work to be done but this update removes sections that are either no longer relevant since moving towards a docker imaged based version of CKAN or updates still relevant sections to how they are to be executed now.

Features:

  • includes tests covering changes
  • includes updated documentation
  • includes user-visible changes
  • includes API changes
  • includes bugfix for possible backport

Please [X] all the boxes above that apply

fostermh and others added 6 commits June 7, 2024 12:19
replaced many references to docker-compose
removed references to CKAN configuration volume
removed references to updating modules and non-root installs of ckan
how to build ckan will be reworked in the document
replaced many references to produciton.ini with ckan.ini
fixing some typos
When installing CKAN for the first time there is a permissions issue with the logging destination, while covered in the release notes for 1.6.0 it's not obvious what's going on unless you know to look there.
…in cases where they no longer exist, alternatives are provided.

References to production.ini are replaced with ckan.ini and related paths as well as the previous userid (900) with the current (92).

Removed sections and parts that are no longer used, additional information or context provided in some cases.

Fixed typos
…longer necessary since we're basing development on existing docker images of ckan and not building from source.
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 this pull request may close these issues.

2 participants