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

Removing map endpoint in favor of usrse-map. #208

Merged
merged 1 commit into from Apr 22, 2020
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 3 additions & 4 deletions .circleci/config.yml
Expand Up @@ -16,11 +16,10 @@ install: &install
command: |
$HOME/conda/bin/pip install -r ~/repo/.circleci/requirements.txt

test_map: &test_map
name: test the metadata required for map
test_jobs: &test_jobs
name: test the jobs metadata
command: |
cd ~/repo/tests
$HOME/conda/bin/python -m unittest test_mapdata
$HOME/conda/bin/python -m unittest test_jobs

install_python_3: &install_python_3
Expand Down Expand Up @@ -79,7 +78,7 @@ jobs:
key: rubygems-v1
paths:
- vendor/bundle
- run: *test_map
- run: *test_jobs
- run: *build_jekyll
- store_artifacts:
path: ~/repo/_site
Expand Down
45 changes: 5 additions & 40 deletions README.md
Expand Up @@ -14,34 +14,10 @@ To do this: fork the repository, make your proposed changes, test locally (see b

### 1. How do I update the map?

If you belong to a group of Research Software Engineers (hooray!), or want
to add yourself as an individual you can do so by adding
an entry to the [_data/map.yml](_data/map.yml) file. Specifically, an entire
should include a name, institution, url, type, and coordinate. The name could be an individual,
or the name of a group. If you are adding yourself as an individual, set the
type to be "person." If you are adding a group, set the type to be "group."
Here is an example:

```yaml
- name: "Stanford Research Computing Center"
url: https://srcc.stanford.edu
coords: [37.424107, -122.166077]
institution: Stanford University
type: group
```

You are also free to add an image parameter, in case your group has a logo.
And of course this could apply to an individual too.

> How do I find a latitude and longitude?

You can actually look it up on [Google Maps](http://maps.google.com), and a more direct approach
is to use [https://www.latlong.net/](https://www.latlong.net/) and enter
your location by name.

> What if I don't have an image, or don't want to include one?

The image is not required. If you leave it out, the box will only contain text.
The [map](https://us-rse.org/usrse-map/) is generated programmatically from the US-RSE member list, so if you
have already [joined](https://us-rse.org/join) and provided your institution,
you should be represented on it. If you see any issues or errors with location
lookup (we use geolocation of a named location) please [open an issue](https://github.com/USRSE/usrse-map/issues).

### 2. How do I add a job?

Expand Down Expand Up @@ -170,18 +146,7 @@ If you want to edit any of the tests, you should edit [config.yml](.circleci/con
Details about running tests locally are included below. This can be good to do if you
change an input file in [_data](_data) and want to test it.

#### 1. Test Map Entries

Other than previewing the site and ensuring that the coordinate shows up in the
correct spot, you can run unit testing locally to confirm you have the minimum
required data:

```bash
$ cd tests
$ python -m unittest test_mapdata
```

#### 2. Test Jobs
#### 1. Test Jobs

Jobs are tested for correctness, meaning that all fields are entered, a date string
is entered for the "expires" field, and the url is valid. You can run tests locally
Expand Down
2 changes: 1 addition & 1 deletion _config.yml
Expand Up @@ -34,7 +34,7 @@ navbar-links:
- About: "about"
- Mission: "mission"
- RSE Groups: "rse-groups"
- RSE Map: "map"
- RSE Map: "https://usrse.github.io/usrse-map"
cosden marked this conversation as resolved.
Show resolved Hide resolved
- Steering Committee: "steering-committee"
- Code of Conduct: "code-of-conduct"
Resources:
Expand Down
1 change: 1 addition & 0 deletions tests/test_mapdata.py
Expand Up @@ -3,6 +3,7 @@
# Read in the map.yml file to validate each entry. Specifically:
# A name, url, and coord is required.
# optional fields are institution, image
# This test was removed April 2020 as the map is at github.com/USRSE/usrse-map

import unittest
import requests
Expand Down