-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation on how to modify the schemas used by DKAN. (#207)
- Loading branch information
Showing
821 changed files
with
28,136 additions
and
4,998 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,18 @@ | ||
| # DKAN | ||
|
|
||
| DKAN for Drupal 8 - Alpha | ||
| DKAN Open Data Portal/Catalog built on Drupal 8 - Alpha | ||
|
|
||
| [](https://circleci.com/gh/GetDKAN/dkan2) | ||
| [](https://codeclimate.com/github/GetDKAN/dkan2/maintainability) | ||
| [](https://codeclimate.com/github/GetDKAN/dkan2/test_coverage) | ||
| [](https://www.gnu.org/licenses/gpl-3.0.en.html) | ||
|
|
||
| DKAN Open Data Portal/Catalog built on Drupal 8. | ||
|
|
||
| As a piece of software in its Alpha cycle, the code is continuously changing and in very active development. | ||
|
|
||
| ## Features | ||
|
|
||
| - Harvesting of data from external catalogs that provide a data.json | ||
| - Dataset metadata and resources | ||
| - Dataset metadata and resources @ref metastore "[Metastore]" | ||
| - Web service API endpoints to work with 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. | ||
|
|
||
| ## Requirements | ||
|
|
||
| 1. Install [dkan-tools](https://github.com/GetDKAN/dkan-tools). | ||
| 2. Set an environment variable called ``DRUPAL_VERSION`` with a value of ``V8``. | ||
| 1. On the command line, enter ``export DRUPAL_VERSION=V8`` or set in ``.bashrc`` | ||
| 3. Setup and start the proxy: | ||
| 1. Add `dkan` to `/etc/hosts` | ||
| 2. Start the proxy: | ||
| ``docker run -d -p 80:80 -v /var/run/docker.sock:/tmp/docker.sock:ro jwilder/nginx-proxy`` | ||
|
|
||
|
|
||
| ## Installation | ||
|
|
||
| 1. Create a directory for your project: ``mkdir <directory-name> && cd <directory-name>`` | ||
| 2. Initialize your project with dkan-tools: ``dktl init`` | ||
| 3. Get Drupal: ``dktl get <drupal-version>`` | ||
| 4. Get Drupal dependencies, and install DKAN with a REACT frontend: ``dktl make --frontend`` | ||
| 5. Install DKAN: ``dktl install`` | ||
| 6. Access the site: ``dktl drush uli --uri=dkan`` | ||
|
|
||
| ## Dummy Content | ||
|
|
||
| If you would like some content in the catalog, run the drush command ``dkan-dummy-content:create``. This command requires Drush 9. | ||
|
|
||
| ## Graphical User Interface (GUI) | ||
|
|
||
| DKAN for Drupal 8 is trying to work with independent pieces that can be used no only by us but any other open data catalog. With that goal, we are working with a decoupled React application as the frontend for DKAN. | ||
|
|
||
| The [React App's](https://github.com/GetDKAN/data-catalog-frontend) README contains instruction on how to work with DKAN. | ||
|
|
||
| ### React App Embedded in Drupal | ||
|
|
||
| DKAN comes with an integration module that allows the React App driving the frontend to be embedded in Drupal. | ||
|
|
||
| To get the integration working follow these steps: | ||
| 1. Place the source for the ``data-catalog-frontend`` in side of your ``docroot`` directory. | ||
| 2. Follow the instructions in the README of ``data-catalog-frontend``, but instead of runnig the development server at the end, build a copy with ``npm run build`` | ||
| 3. Enable the integration module ``dkan_frontend`` | ||
| 4. Change the sites configuration to point the homepage (``/``) to ``/home`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| <!-- HTML header for doxygen 1.8.16--> | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> | ||
| <meta name="generator" content="Doxygen 1.8.17"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>DKAN: docs_assets/pages/01_installation.md File Reference</title> | ||
| <link rel="shortcut icon" href="favicon.ico" type="image/x-icon" /> | ||
| <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||
| <link href="all.min.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="jquery.js"></script> | ||
| <script type="text/javascript" src="dynsections.js"></script> | ||
| <link href="navtree.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="resize.js"></script> | ||
| <script type="text/javascript" src="navtreedata.js"></script> | ||
| <script type="text/javascript" src="navtree.js"></script> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||
| $(document).ready(initResizable); | ||
| /* @license-end */</script> | ||
| <link href="search/search.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="search/searchdata.js"></script> | ||
| <script type="text/javascript" src="search/search.js"></script> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||
| $(document).ready(function() { init_search(); }); | ||
| /* @license-end */ | ||
| </script> | ||
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
| <link href="custom.css" rel="stylesheet" type="text/css"/> | ||
| </head> | ||
| <body> | ||
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | ||
| <div id="titlearea"> | ||
| <div id="projectlogo"> | ||
| <img alt="Logo" src="logo.svg"/> | ||
| </div> | ||
| <!-- <div id="projectname">DKAN</div> --> | ||
| <div id="projectdetails"> | ||
| <span id="projectbrief">Alpha</span> | ||
| <span id="projectnumber">v2.0.2</span> | ||
| </div> | ||
| <div id="search"> | ||
| <div id="MSearchBox" class="MSearchBoxInactive"> | ||
| <span class="left"> | ||
| <img id="MSearchSelect" src="search/mag_sel.png" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| alt=""/> | ||
| <input type="text" id="MSearchField" value="Search" accesskey="S" | ||
| onfocus="searchBox.OnSearchFieldFocus(true)" | ||
| onblur="searchBox.OnSearchFieldFocus(false)" | ||
| onkeyup="searchBox.OnSearchFieldChange(event)"/> | ||
| </span><span class="right"> | ||
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> | ||
| </span> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.8.17 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); | ||
| /* @license-end */ | ||
| </script> | ||
| </div><!-- top --> | ||
| <div id="side-nav" class="ui-resizable side-nav-resizable"> | ||
| <div id="nav-tree"> | ||
| <div id="nav-tree-contents"> | ||
| <div id="nav-sync" class="sync"></div> | ||
| </div> | ||
| </div> | ||
| <div id="splitbar" style="-moz-user-select:none;" | ||
| class="ui-resizable-handle"> | ||
| </div> | ||
| </div> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||
| $(document).ready(function(){initNavTree('01__installation_8md.html','');}); | ||
| /* @license-end */ | ||
| </script> | ||
| <div id="doc-content"> | ||
| <!-- window showing the filter options --> | ||
| <div id="MSearchSelectWindow" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
| </div> | ||
|
|
||
| <!-- iframe showing the search results (closed by default) --> | ||
| <div id="MSearchResultsWindow"> | ||
| <iframe src="javascript:void(0)" frameborder="0" | ||
| name="MSearchResults" id="MSearchResults"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| <div class="header"> | ||
| <div class="headertitle"> | ||
| <div class="title">docs_assets/pages/01_installation.md File Reference</div> </div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
| </div><!-- contents --> | ||
| </div><!-- doc-content --> | ||
| <!-- start footer part --> | ||
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||
| <ul> | ||
| <li class="navelem"><a class="el" href="01__installation_8md.html">01_installation.md</a></li> | ||
| <li class="footer">Generated by | ||
| <a href="http://www.doxygen.org/index.html"> | ||
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> | ||
| </ul> | ||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.