Skip to content

Commit c753439

Browse files
authored
Update links to documentation and the repo (#591)
1 parent 31a5053 commit c753439

File tree

9 files changed

+38
-30
lines changed

9 files changed

+38
-30
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,22 @@ The Open Location Code project strongly encourages technical contributions.
44

55
We hope you'll become an ongoing participant in our open source community, but we also welcome one-off contributions for the issues you're particularly passionate about.
66

7-
- [Filing issues](#filing-issues)
8-
* [Bugs](#bugs)
9-
* [Suggestions](#suggestions)
10-
- [Contributing code](#contributing-code)
11-
- [Contributing a new implementation](#contributing-a-new-implementation)
12-
- [Contributor License Agreement](#contributor-license-agreement)
13-
- [Ongoing participation](#ongoing-participation)
14-
* [Discussion channels](#discussion-channels)
7+
- [Contributing to Open Location Code](#contributing-to-open-location-code)
8+
- [Filing issues](#filing-issues)
9+
- [Bugs](#bugs)
10+
- [Suggestions](#suggestions)
11+
- [Contributing code](#contributing-code)
12+
- [Contributing a new implementation](#contributing-a-new-implementation)
13+
- [Contributor License Agreement](#contributor-license-agreement)
14+
- [Ongoing participation](#ongoing-participation)
15+
- [Discussion channels](#discussion-channels)
1516

1617
## Filing issues
1718

1819
### Bugs
1920

20-
If you find a bug in an Open Location Code library, please [file an issue](https://github.com/google/open-location-code/issues/new). Members of the community are regularly monitoring issues and will try to fix open bugs quickly.
21+
If you find a bug in an Open Location Code library, please [file an issue](https://github.com/google/open-location-code/issues/new).
22+
Members of the community are regularly monitoring issues and will try to fix open bugs quickly.
2123

2224
The best bug reports provide a detailed description of the issue, step-by-step instructions for predictably reproducing the issue, and possibly even a working example that demonstrates the issue.
2325

@@ -26,7 +28,8 @@ instead of filing an issue here.
2628

2729
### Suggestions
2830

29-
The Open Location Code project is meant to evolve with feedback. The project and its users appreciate your thoughts on ways to improve the design or features or creative ways to use the codes.
31+
The Open Location Code project is meant to evolve with feedback.
32+
The project and its users appreciate your thoughts on ways to improve the design or features or creative ways to use the codes.
3033

3134
To make a suggestion [file an issue](https://github.com/google/open-location-code/issues/new).
3235

@@ -41,26 +44,31 @@ The Open Location Code project accepts and greatly appreciates code contribution
4144
A few things to note:
4245

4346
* The Open Location Code project follows the [fork & pull](https://help.github.com/articles/using-pull-requests/#fork--pull) model for accepting contributions.
44-
* We follow [Google's JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html). More generally make sure to follow the same comment and coding style as the rest of the project.
45-
* Do not try to address multiple issues in a single pull request. In some cases, you might even resolve a single issue with multiple PRs (e.g. if you are changing multiple implementations).
46-
* Include [tests](TESTING.md) when contributing code. There are tests that you can use as examples.
47+
* We follow [Google's JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html).
48+
More generally make sure to follow the same comment and coding style as the rest of the project.
49+
* Do not try to address multiple issues in a single pull request.
50+
In some cases, you might even resolve a single issue with multiple PRs (e.g. if you are changing multiple implementations).
51+
* Include [tests](TESTING.md) when contributing code.
52+
There are tests that you can use as examples.
4753

4854
## Contributing a new implementation
4955

50-
If you have an implementation in your own repository, that's great! Just add a link to it in our [wiki](https://github.com/google/open-location-code/wiki/Other-Implementations).
51-
52-
Follow this process for contributing a new implementation:
56+
If you have an implementation in your own repository, that's great!
57+
Unfortunately we can't accept implementations in languages we're not familiar with as we won't be able to maintain or test them.
58+
You can add a link to it in our [list of external implementations](Documentation/External_Implementations.md).
5359

5460
* Look at the existing implementations, to get an idea of the usage and how much work is involved.
5561
* If you copy the code structure and algorithms from an existing implementation, you'll have a much shorter review cycle.
5662
* [Create a new GitHub issue](https://github.com/google/open-location-code/issues/new) to start discussion of the new feature.
5763
* Follow the guidelines for [Contributing code](#contributing-code) described above.
64+
* Don't forget to add tests!
5865

5966
## Contributor License Agreement
6067

6168
The Open Location Code project hosted at GitHub requires all contributors to sign a Contributor License Agreement ([individual](https://developers.google.com/open-source/cla/individual) or [corporation](https://developers.google.com/open-source/cla/corporate)) in order to protect contributors, users and Google in issues of intellectual property.
6269

63-
When you create a Pull Request, a check will be run to ensure that you have signed the CLA. Make sure that you sign the CLA with the same email address you associate with your commits (likely via the `user.email` Git config as described on GitHub's [Set up Git](https://help.github.com/articles/set-up-git/) page).
70+
When you create a Pull Request, a check will be run to ensure that you have signed the CLA.
71+
Make sure that you sign the CLA with the same email address you associate with your commits (likely via the `user.email` Git config as described on GitHub's [Set up Git](https://help.github.com/articles/set-up-git/) page).
6472

6573
## Ongoing participation
6674

Documentation/Reference/App_Developers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This page gives guidelines for how to support plus codes in a website or mapping application.
44
These guidelines should make it clear that adding support for OLC is not onerous, but actually quite easy.
55

6-
> Note that with the availability of the [plus codes API](https://github.com/google/open-location-code/wiki/Plus-code-API), these instructions really only apply to apps that require offline support.
6+
> Note that with the availability of the [https://plus.codes website API](plus.codes_Website_API.md), these instructions really only apply to apps that require offline support.
77
If your app or site can rely on a network connection, integrating with the API will give a better solution.
88

99
# Supporting plus codes for search

Documentation/Reference/GIS_Software.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This page provides information about using plus codes in GIS software.
77
If you want to visualise the plus codes grid, you can use the [grid service](https://grid.plus.codes) to fetch the grid tiles.
88

99
This is a shared service, and it may rate limit you.
10-
If you need to use the grid heavily, you can start your own [tile_server](https://github.com/google/open-location-code/tree/master/tile_server).
10+
If you need to use the grid heavily, you can start your own [tile_server](https://github.com/google/open-location-code/blob/main/tile_server).
1111

1212
The tile service provides GeoJSON objects, one per plus codes square, or PNG images that can be added as an overlay.
1313

Documentation/Reference/Using_Spreadsheets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The [plus codes youtube channel](https://www.youtube.com/c/pluscodes) has some [
1212

1313
## Excel/LibreOffice
1414

15-
VBA script and instructions are checked into github [here](https://github.com/google/open-location-code/tree/master/visualbasic).
15+
VBA script and instructions are checked into github [here](https://github.com/google/open-location-code/blob/main/visualbasic).
1616

1717
LibreOffice does sometimes have problems.
1818
This may be due to slightly unreliable VBA support in some versions.

Documentation/Reference/comparison.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Open Post Codes <<openpostcode-site>> can be defined globally or within a contai
153153
Codes, but codes defined within a country are shorter than full Open
154154
Location Codes, and a similar length to short Open Location Codes.
155155

156-
Four countries are defined: Ireland, Hong Kong, Yemen and India.
156+
Four countries are defined: Ireland, Hong Kong, Yemen and India.
157157

158158
Every location on the planet has a global code. Locations within the
159159
countries where Open Post Code has been defined also have a local code.
@@ -249,7 +249,7 @@ information such as contact details, photos etc in addition to the location.
249249

250250
We felt that the attributes of the above systems didn't sufficiently meet
251251
our requirements. As a result, we defined a new coding system and termed it
252-
Open Location Code; codes created using this system are referred to as 'plus codes' (see the link:https://github.com/google/open-location-code/wiki/Naming-Guidelines[Naming Guidelines]).
252+
Open Location Code; codes created using this system are referred to as 'plus codes' (see the link:../Specification/Naming_Guidelines.md[Naming Guidelines]).
253253

254254
Plus codes are 10 to 11 characters long. They can also be used in a
255255
short form of four to seven characters, similar to telephone numbers and

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ Codes can be shortened for easier communication, in which case they can be used
2525
Algorithms to
2626
* encode and decode full codes,
2727
* shorten them relative to a reference location, and
28-
* recover a location from a short code and a reference location given as latitude/longitude pair
28+
* recover a location from a short code and a reference location given as latitude/longitude pair
2929

3030
are publicly available and can be used without restriction. Geocoding services are not a part of the Open Location Code technology.
3131

3232
Links
3333
-----
3434
* [Demonstration site](http://plus.codes/)
3535
* [Mailing list](https://groups.google.com/forum/#!forum/open-location-code)
36-
* [Comparison of existing location encoding systems](https://github.com/google/open-location-code/wiki/Evaluation-of-Location-Encoding-Systems)
37-
* [Open Location Code definition](https://github.com/google/open-location-code/blob/master/docs/olc_definition.adoc)
36+
* [Comparison of existing location encoding systems](Documentation/Reference/comparison.adoc)
37+
* [Open Location Code definition](Documentation/Specification/olc_definition.adoc)
3838

3939
Description
4040
-----------
@@ -74,7 +74,7 @@ Rather than a large city size feature to generate the reference location, it is
7474
better to use smaller, neighbourhood features, that will not have as much
7575
variation in their geocode results.
7676

77-
Guidelines for shortening codes are in the [wiki](https://github.com/google/open-location-code/wiki/Guidance-for-shortening-codes).
77+
Guidelines for shortening codes are in the [wiki](Documentation/Specification/Short_Code_Guidance.md).
7878

7979
Recovering shortened codes works by providing the short code and a reference
8080
location. This does not need to be the same as the location used to shorten the

TESTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Testing
2-
The preferred mechanism for testing is using the [Bazel](https://bazel.build/) build system. This uses files called `BUILD` ([example](https://github.com/google/open-location-code/blob/master/BUILD) to provide rules to build code and run tests).
2+
The preferred mechanism for testing is using the [Bazel](https://bazel.build/) build system. This uses files called `BUILD` ([example](https://github.com/google/open-location-code/blob/main/python/BUILD) to provide rules to build code and run tests).
33

44
Create a `BUILD` file in your code directory with a [test rule](https://bazel.build/versions/master/docs/test-encyclopedia.html).
55
You can then test your code by running:
@@ -57,7 +57,7 @@ An example of a language using bazel is Python:
5757
name: test-python-${{ matrix.python }}
5858
steps:
5959
- uses: actions/checkout@v2
60-
- name: Set up Python
60+
- name: Set up Python
6161
uses: actions/setup-python@v2
6262
with:
6363
python-version: ${{ matrix.python }}

java/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ executed by running `mvn pmd:pmd pmd:check`.
2020

2121
## Building and Testing
2222

23-
Note: the tests read their data from the [`test_data`](https://github.com/google/open-location-code/tree/master/test_data) directory.
23+
Note: the tests read their data from the [`test_data`](https://github.com/google/open-location-code/blob/main/test_data) directory.
2424

2525
### Maven
2626

js/closure/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Included is a `BUILD` file that uses the [Bazel](https://bazel.build/) build sys
3333

3434
The tests use the [Closure Rules for Basel](https://github.com/bazelbuild/rules_closure) project although this is retrieved automatically and you don't have to install anything.
3535

36-
The test cases have been copied from the [`test_data`](https://github.com/google/open-location-code/tree/master/test_data) directory due to restrictions on loading data files within the test runner.
36+
The test cases have been copied from the [`test_data`](https://github.com/google/open-location-code/blob/main/test_data) directory due to restrictions on loading data files within the test runner.
3737

3838
Run the tests from the top-level github directory with:
3939

0 commit comments

Comments
 (0)