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

fix broken link #592

Merged
merged 1 commit into from
Mar 1, 2023
Merged

fix broken link #592

merged 1 commit into from
Mar 1, 2023

Conversation

joshfischer1108
Copy link
Member

This PR fixes a broken link in the README

@sonarcloud
Copy link

sonarcloud bot commented Mar 1, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link
Member

@bchapuis bchapuis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joshfischer1108 Thanks a lot, there is still a lot of work to be made on the documentation. For information, I started experimenting with nextra yesterday evening, the goal is to include maps and demonstrations directory in the documentation.

@joshfischer1108
Copy link
Member Author

joshfischer1108 commented Mar 1, 2023

@joshfischer1108 Thanks a lot, there is still a lot of work to be made on the documentation. For information, I started experimenting with nextra yesterday evening, the goal is to include maps and demonstrations directory in the documentation.

I agree. A few things I think about when I hit the documentation page is:

  • Why would use baremaps over competitors?
  • Can the same thing be done with Google Maps and Apple Maps? If so, what is special about Baremaps over the prior mentioned?
  • The documentation seems to written for the persona of someone who understands GIS a fair amount. Some examples are pages with the titles
    *Import Natural Earth data into PostGIS
    • Serve Vector Tiles from PostGIS
      I would expect a developer with minimal GIS experience to think "why would I want to do import Natural earth data or serve vector tiles?".

@joshfischer1108 joshfischer1108 merged commit 02a2e9e into main Mar 1, 2023
@joshfischer1108 joshfischer1108 deleted the joshfischer/fix-broken-link branch March 1, 2023 14:35
@CalvinKirs
Copy link
Member

Another good practice is that we can add this one of the good parties is we can used markdown-link-check check in CI

@bchapuis
Copy link
Member

bchapuis commented Mar 1, 2023

The documentation seems to written for the persona of someone who understands GIS a fair amount.

Yes, the current documentation is intended at people who need some advanced level of customisation. The idea is to let the user regain control over the data shown in the map. Do you think we should change the way of presenting things and be more general? Some apache web sites are very nice and catchy (e.g. Apache Ignite).

@bchapuis
Copy link
Member

bchapuis commented Mar 1, 2023

For information, here is the results of my experiments with nextjs and nextra.

apache/incubator-baremaps-site#12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants