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.

Sign up for GitHub

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

Update links to the documentation #593

Merged
merged 1 commit into from
Mar 2, 2023
Merged

Update links to the documentation #593

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,34 +19,34 @@

## 📖 How do I use Apache Baremaps?

You can find the official documentation at [https://baremaps.apache.org/](https://baremaps.apache.org/). The following pages showcase the main uses of Apache Baremaps.
You can find the documentation on the project's [website](https://baremaps.apache.org/). The following pages showcase the main uses of Apache Baremaps.

- The [OpenStreetMap](https://baremaps.apache.org/examples/import-osm-into-postgis/) example is a good introduction to Baremaps, it shows how to produce high resolution vector tiles.
- The [NaturalEarth](https://baremaps.apache.org/examples/import-naturalearth-into-postgis/) example shows how to produce low resolution vector tiles.
- The [Contour](https://baremaps.apache.org/examples/import-contour-into-postgis/) example shows how to produce contour lines from a digital elevation model.
- The [IP to location](https://baremaps.apache.org/examples/ip-to-location/) example shows how to create and serve an IP to location service in a simple web application.
- The [Geocoding](https://baremaps.apache.org/examples/geocoding/) example shows how to create and serve a geocoding service in a simple web application.
- The [OpenStreetMap](https://baremaps.apache.org/documentation/examples/import-osm-into-postgis) example is a good introduction to Baremaps, it shows how to produce high resolution vector tiles.
- The [NaturalEarth](https://baremaps.apache.org/documentation/examples/import-naturalearth-into-postgis) example shows how to produce low resolution vector tiles.
- The [Contour](https://baremaps.apache.org/documentation/examples/import-contour-into-postgis) example shows how to produce contour lines from a digital elevation model.
- The [IP to location](https://baremaps.apache.org/documentation/examples/ip-to-location) example shows how to create and serve an IP to location service in a simple web application.
- The [Geocoding](https://baremaps.apache.org/documentation/examples/geocoding) example shows how to create and serve a geocoding service in a simple web application.

## 👩‍💻 How do I contribute?

There are many places where you can contribute to Apache Baremaps such as the code, the documentation, the website or the examples.

The official documentation is located in a separate repository available here [https://github.com/apache/incubator-baremaps-site](https://github.com/apache/incubator-baremaps-site).
The official documentation is located in a separate [repository](https://github.com/apache/incubator-baremaps-site).

If you want to contribute to the code you can refer to the following developer guides available in the documentation.

- [Project structure](https://baremaps.apache.org/developer-manual/project-structure/)
- [How to build with Maven](https://baremaps.apache.org/developer-manual/how-to-build-with-maven/)
- [Set up in IntelliJ IDEA](https://baremaps.apache.org/developer-manual/setup-in-intellij/)
- [Geocoder](https://baremaps.apache.org/developer-manual/geocoder/)
- [IP to location](https://baremaps.apache.org/developer-manual/ip-to-location/)
- [Stylesheet](https://baremaps.apache.org/developer-manual/stylesheet/)
- [Project structure](https://baremaps.apache.org/documentation/developer-manual/project-structure)
- [How to build with Maven](https://baremaps.apache.org/documentation/developer-manual/how-to-build-with-maven)
- [Set up in IntelliJ IDEA](https://baremaps.apache.org/documentation/developer-manual/setup-in-intellij)
- [Geocoder](https://baremaps.apache.org/documentation/developer-manual/geocoder)
- [IP to location](https://baremaps.apache.org/documentation/developer-manual/ip-to-location)
- [Basemap](https://baremaps.apache.org/documentation/developer-manual/basemap)

You can also contribute in the following ways.

- [Create an issue](https://github.com/apache/incubator-baremaps/issues): Report a bug or feature request
- [Join the mailing list](https://lists.apache.org/list.html?dev@baremaps.apache.org): Initiate or participate in project discussions on the mailing list
- [Write a post](https://medium.com/): Write a post to share your use cases and experiences with Apache Baremaps
- Write a post: Write a post to share your use cases and experiences with Apache Baremaps

Finally, check out [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md).

Expand Down