Skip to content

Commit

Permalink
Merge pull request #219 from openreferral/2.0-dev
Browse files Browse the repository at this point in the history
2.0 Upgrade #WIP #draft
  • Loading branch information
greggish authored Oct 26, 2020
2 parents 3c9d247 + e7a6c54 commit 88e080d
Show file tree
Hide file tree
Showing 30 changed files with 747 additions and 821 deletions.
9 changes: 6 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
language: python
python:
- "3.5"
#install:
# - pip install -r requirements.txt
- "3.8"
install:
- pip install -r requirements.txt
- wget 'https://specs.frictionlessdata.io/schemas/tabular-data-package.json'
script:
# Check that datapackage.json is well formed JSON
- python -c 'import json; json.load(open("datapackage.json"))'
# Check that datapackage.json validates against the tabular data package json schema
- jsonschema -i datapackage.json tabular-data-package.json
sudo: false
5 changes: 2 additions & 3 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ A summary of this license is available at https://creativecommons.org/licenses/b

Unless otherwise stated, contributions are copyright of the Open Referral project.

Our preferred form of attribution is "Humanitarian Service Data Specification: an Open Referral resource (https://openreferral.org/)"
Our preferred form of attribution is "Human Services Data Specification: an Open Referral resource (https://openreferral.org/)"

The Open Referral project is stewarded by Greg Bloom, and is working towards a formal legal structure.
The Open Referral project is stewarded by Greg Bloom.

Version 1.0 of the specification is also available under a CC0 Public Domain Dedication


Creative Commons Attribution-ShareAlike 4.0 International Public License
=============================================================

Expand Down
37 changes: 14 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Open Referral

Human Services Data Specification defines a minimal set of data for publishing machine-readable directory information about health, human, and social services; their locations and accessibility details; and the organizations that provide them. Read the [spec here](http://docs.openreferral.org).
The Open Referral Initiative develops data standards and open platforms that make it easy to share and find information about community resources. Learn more about the initiative at [OpenReferral.org](https://openreferral.org).

A detailed FAQ about the project is [found here](http://docs.openreferral.org/en/latest/faq), and additional information about the Open Referral Initiative is available at [https://openreferral.org](https://openreferral.org)
## Standards

The Open Referral initiative defines two standards - the Human Services Data Specification and the Human Services Data API.

This project also integrates documentation for the [Human Services Data API specification](https://github.com/openreferral/api-specification) which builds upon HSDS.
Human Services Data Specification defines a minimal set of data for publishing machine-readable directory information about health, human, and social services; their locations and accessibility details; and the organizations that provide them. Read the [spec here](https://docs.openreferral.org).

The [Human Services Data API specification](https://github.com/openreferral/api-specification) builds upon HSDS.

A detailed FAQ about the project is [found here](http://docs.openreferral.org/en/latest/faq), and additional information about the Open Referral Initiative is available at [https://openreferral.org](https://openreferral.org)

## License

Expand All @@ -18,28 +24,28 @@ Earlier versions were licensed under CC0.

### ReadTheDocs

Any change pushed to the master branch on GitHub will be built and pushed to http://docs.openreferral.org/en/latest/ automatically by readthedocs. Build info is found at https://readthedocs.org/projects/openreferral/builds/
Any change pushed to the master branch on GitHub will be built and pushed to http://docs.openreferral.org/en/latest/ automatically by ReadTheDocs. Build info is found at https://readthedocs.org/projects/openreferral/builds/

Other branches are not built automatically, but can be configured by admin's of the 'openreferral' project on readthedocs, on this page - https://readthedocs.org/projects/openreferral/versions/
Other branches are not built automatically, but can be configured by admins of the 'openreferral' project on ReadTheDocs, on this page - https://readthedocs.org/projects/openreferral/versions/

### Building locally

Assuming a unix based system with Python 3 installed, set up an environment:
Assuming a UNIX-based system with Python 3 installed, set up an environment:

```
python3 -m venv .ve
source .ve/bin/activate
pip install -r requirements.txt
```

Then pull in the submodule for the api-documentation.
Then pull in the submodule for the API documentation.

```
git submodule init
git submodule update
```

The update command should be re-run whenever there are updates to the api-specification repository.
The update command should be re-run whenever there are updates to the `api-specification` repository.

To build the docs:

Expand All @@ -55,18 +61,3 @@ pip install sphinx-autobuild
cd docs
sphinx-autobuild . _build
```

### Translations

Translations wil be done using this transifex project - https://www.transifex.com/OpenDataServices/open-referral-1-0/

How to push new text up to Transifex:
First, do a local build, then:

```
cd docs
make gettext
sphinx-intl update-txconfig-resources --transifex-project-name open-referral-1-0
```

Then follow the rest of the instructions at https://github.com/open-contracting/standard#translations
Loading

0 comments on commit 88e080d

Please sign in to comment.