From 91d836a9300a6867fb202af1725532e241e4702c Mon Sep 17 00:00:00 2001 From: Janette Day Date: Fri, 28 Apr 2023 19:29:57 -0500 Subject: [PATCH] Update readme and installation docs (#3951) --- README.md | 18 ++++--------- cypress/integration/09_admin_links.spec.js | 30 +++++++++++----------- docs/source/conf.py | 3 ++- docs/source/installation/index.rst | 8 ++++-- 4 files changed, 28 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 9959533dc6..a9d9f4dc86 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # DKAN -[DKAN](https://getdkan.com) - An Open Data Catalog built on [Drupal 9](https://www.drupal.org/documentation) +[DKAN](https://dkan.readthedocs.io/en/latest) - 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) @@ -9,16 +9,8 @@ --- ## Documentation -DKAN's documentation lives at [docs.getdkan.com](https://docs.getdkan.com/) +DKAN's documentation can be found at https://dkan.readthedocs.io/en/latest -To generate the docs with a specfic version number, run: -``` -DKAN_VERSION='v2.1.0' doxygen -``` -To supply the current branch, run: -``` -DKAN_VERSION=`git rev-parse --abbrev-ref HEAD` doxygen -``` --- @@ -26,9 +18,9 @@ DKAN_VERSION=`git rev-parse --abbrev-ref HEAD` doxygen - Harvesting of data from external catalogs that provide a data.json - Dataset metadata and resources -- Web service API endpoints that allow third party applications to work with the datasets -- Integration with a decoupled [REACT front end](https://github.com/getdkan/data-catalog-frontend) -- A datastore to store CSV files and make them queryable through an SQL endpoint. +- Web service API endpoints that provide remote/automated management of datasets +- Integration with a decoupled [REACT front end](https://github.com/getdkan/data-catalog-app) +- A datastore to store CSV data files and make them queryable by third party applications. --- diff --git a/cypress/integration/09_admin_links.spec.js b/cypress/integration/09_admin_links.spec.js index 5c1e5fb146..9b372b451e 100755 --- a/cypress/integration/09_admin_links.spec.js +++ b/cypress/integration/09_admin_links.spec.js @@ -7,45 +7,45 @@ context('Administration pages', () => { }) it('I should see a link for the dataset properties configuration', () => { - cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-menu').then($el=>{ - cy.wrap($el).invoke('show') - cy.wrap($el).contains('Metastore referencer') + cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-handle').then($el=>{ + cy.wrap($el).click() + cy.get('.toolbar-menu').contains('Metastore referencer') }) cy.visit(baseurl + "/admin/dkan/properties") cy.get('.option').should('contain.text', 'Distribution (distribution)') }) it('I should see a link for the datastore configuration', () => { - cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-menu').then($el=>{ - cy.wrap($el).invoke('show') - cy.wrap($el).contains('Datastore settings') + cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-handle').then($el=>{ + cy.wrap($el).click() + cy.get('.toolbar-menu').contains('Datastore settings') }) cy.visit(baseurl + "/admin/dkan/datastore") cy.get('label[for="edit-rows-limit"]').should('have.text', 'Rows limit') }) it('I should see a link for the datastore status', () => { - cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-menu').then($el=>{ - cy.wrap($el).invoke('show') - cy.wrap($el).contains('Datastore Import Status') + cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-handle').then($el=>{ + cy.wrap($el).click() + cy.get('.toolbar-menu').contains('Datastore Import Status') }) cy.visit(baseurl + "/admin/dkan/datastore/status") cy.contains('h1', 'Datastore Import Status'); }) it('I should see a link for the harvest status', () => { - cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-menu').then($el=>{ - cy.wrap($el).invoke('show') - cy.wrap($el).contains('Harvests') + cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-handle').then($el=>{ + cy.wrap($el).click() + cy.get('.toolbar-menu').contains('Harvests') }) cy.visit(baseurl + "/admin/dkan/harvest") cy.contains('h1', 'Harvests'); }) it('There is a link in the admin menu to the datasets admin screen.', () => { - cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-menu').then($el=> { - cy.wrap($el).invoke('show') - cy.wrap($el).contains('Datasets') + cy.get('.toolbar-icon-system-admin-dkan').contains('DKAN').next('.toolbar-handle').then($el=> { + cy.wrap($el).click() + cy.get('.toolbar-menu').contains('Datasets') }) }) diff --git a/docs/source/conf.py b/docs/source/conf.py index 5f12d89122..456336ac45 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -35,7 +35,8 @@ extensions = [ 'myst_parser', 'sphinx.ext.autosectionlabel', - 'sphinxcontrib.httpdomain' + 'sphinxcontrib.httpdomain', + 'sphinx_rtd_theme' ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst index 5c08cba169..3ceae9a3d2 100644 --- a/docs/source/installation/index.rst +++ b/docs/source/installation/index.rst @@ -7,13 +7,17 @@ Installation 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 `_-based local environment is recommended. -`DDEV `_ with the `DKAN DDev Addon `_ command-line utility will work on Mac or Linux to create containers for the various services needed by DKAN. + +- [Installing Docker](https://ddev.readthedocs.io/en/latest/users/install/docker-installation/) +- [Installing DDEV](https://ddev.readthedocs.io/en/latest/users/install/ddev-installation/) + +Using `DDEV `_ with the `DKAN DDev Addon `_ command-line utility will work on Mac, Linux, or Windows 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. Requirements ------------ -DKAN is based on Drupal software and -- generally -- runs anywhere Drupal is supported. For the most common setup, we reccomend: +DKAN is based on `Drupal software `_ and -- generally -- runs anywhere Drupal is supported. For the most common setup, we reccomend: - MySQL: minimum version 5.7.8+ with PDO - PHP: minimum version 7.4.x or 8.0