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

Swap out dkan-tools with ddev-addon. #3846

Merged
merged 2 commits into from
Feb 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# DKAN
[DKAN](https://getdkan.com) - An Open Data Catalog built on [Drupal 8](https://www.drupal.org/documentation)
[DKAN](https://getdkan.com) - An Open Data Catalog built on [Drupal 9](https://www.drupal.org/documentation)

[![GetDKAN](https://circleci.com/gh/GetDKAN/dkan/tree/2.x.svg?style=svg)](https://circleci.com/gh/GetDKAN/dkan/tree/2.x)
[![Maintainability](https://api.codeclimate.com/v1/badges/a02bf3362b94749579a1/maintainability)](https://codeclimate.com/github/GetDKAN/dkan/maintainability)
Expand Down
8 changes: 3 additions & 5 deletions docs_assets/pages/1.0_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@

@note
<i class="fas fa-toolbox" style="color: #42b983"></i>
[DKAN Tools](https://github.com/GetDKAN/dkan-tools) is a project
[DKAN DDev Addon](https://getdkan.github.io/dkan-ddev-addon/) is a project
containing commands and tools that [CivicActions](https://civicactions.com/dkan/)
uses for our own implementations and deployments.

For either working on a project locally or working on the core DKAN software and libraries, using a standardized, [docker](https://www.docker.com/)-based local environment is recommended. Our DKAN Tools command-line utility will work on Mac or Linux to create containers for the various services needed by DKAN. This will ensure you have the same setup as DKAN's core developers, and that your environment is very close to that of our continuous integration tools.

It is possible, though not reccomended, to use DKAN Tools [without docker](https://github.com/GetDKAN/dkan-tools/tree/master#running-without-docker) and using your system's native webserver, [PHP](https://www.php.net), and database tools; see the DKAN Tools [documentation](https://github.com/GetDKAN/dkan-tools).

## Requirements

DKAN is based on Drupal software and -- generally -- runs anywhere Drupal is supported. For the most common setup, we reccomend:
Expand All @@ -22,9 +20,9 @@ DKAN is based on Drupal software and -- generally -- runs anywhere Drupal is sup

## Starting a new project

The DKAN team maintains a CLI tool to manage initial setup and local development environments for DKAN projects. Follow the instructions from the DKAN Tools documentation: [Starting a new project](https://getdkan.github.io/dkan-tools/#newproject/) to generate a new Drupal site with DKAN installed on your system.
Follow the instructions from the DKAN DDev Addon documentation: [Starting a new project](https://getdkan.github.io/dkan-ddev-addon/getting-started.html) to generate a new Drupal site with DKAN installed on your system.

DKAN tools bases new projects off of a [composer project](https://github.com/GetDKAN/recommended-project) that you can also use to start a project using your own toolset:
DKAN DDev Addon bases new projects off of a [composer project](https://github.com/GetDKAN/recommended-project) that you can also use to start a project using your own toolset:

composer create-project getdkan/recommended-project my-project

Expand Down