From 6b9ef826fb34c10e187a089108dfe522c90be3c7 Mon Sep 17 00:00:00 2001 From: Xiaoji Chen Date: Thu, 3 Oct 2024 10:46:45 -0700 Subject: [PATCH] Fix misspelled library name in docs and templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 6 +++--- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 2 +- docs/upgrade-guide.md | 2 +- examples/controls/README.md | 2 +- scripts/update-release-branch.sh | 8 ++++---- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 719cda9..ff95970 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -7,8 +7,8 @@ body: attributes: value: | Thank you for taking the time to report a bug! - You may find answers faster by searching in [the documentation](https://visgl.github.io/react-maplibre-gl/search) and [existing issues](https://github.com/visgl/react-maplibre-gl/issue). - If you are unsure whether it is a bug in your own implementation or the library itself, consider starting a conversation in [Discussions](https://github.com/visgl/react-maplibre-gl/discussions) instead. + You may find answers faster by searching in [the documentation](https://visgl.github.io/react-maplibre/search) and [existing issues](https://github.com/visgl/react-maplibre/issue). + If you are unsure whether it is a bug in your own implementation or the library itself, consider starting a conversation in [Discussions](https://github.com/visgl/react-maplibre/discussions) instead. - type: textarea attributes: label: Description @@ -33,7 +33,7 @@ body: label: Environment description: | Example: - - **Framework version**: react-maplibre-gl@7.0.0 + - **Framework version**: @vis.gl/react-maplibre@1.0.0 - **Map library**: maplibre-gl@4.7.0 - **Browser**: Chrome 129.0 - **OS**: iOS 16.1 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8cb62f9..ed99a33 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: I have a question / I need help - url: https://github.com/visgl/react-maplibre-gl/discussions + url: https://github.com/visgl/react-maplibre/discussions about: Ask generic questions or request help here diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index ea7fe0b..0ad2b34 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Tell us what you are using react-maplibre-gl for and how we can make it better. + Tell us what you are using react-maplibre for and how we can make it better. This project is maintained by volunteers and sponsoring companies. While we cannot promise a timeline for any specific feature, we try to prioritize those that will benefit the most users. - type: textarea attributes: diff --git a/docs/upgrade-guide.md b/docs/upgrade-guide.md index 8215c2c..3e43654 100644 --- a/docs/upgrade-guide.md +++ b/docs/upgrade-guide.md @@ -6,7 +6,7 @@ ```patch - import {Map, Marker} from 'react-map-gl/maplibre'; -+ import {Map, Marker} from 'react-maplibre-gl'; ++ import {Map, Marker} from '@vis.gl/react-maplibre'; ``` The following Mapbox-only props from `react-map-gl`'s Map component are removed: diff --git a/examples/controls/README.md b/examples/controls/README.md index bd01a5e..0065793 100644 --- a/examples/controls/README.md +++ b/examples/controls/README.md @@ -1,6 +1,6 @@ # Example: Controls -Demonstrates how various control components can be used with react-maplibre-gl. +Demonstrates how various control components can be used with react-maplibre. ## Usage diff --git a/scripts/update-release-branch.sh b/scripts/update-release-branch.sh index a2d8374..2e47441 100755 --- a/scripts/update-release-branch.sh +++ b/scripts/update-release-branch.sh @@ -10,16 +10,16 @@ VERSION=`echo "$1.0"` echo "Updating branch to ${BRANCH}..." # Replace source links in docs and examples -find docs -iname "*.md" -type f -exec sed -i '' -E "s/react-maplibre-gl\/(tree|blob)\/(master|[0-9\.]+-release)/react-maplibre-gl\/tree\/${BRANCH}/g" {} \; -find examples -maxdepth 0 -iname "*.md" -type f -exec sed -i '' -E "s/react-maplibre-gl\/(tree|blob)\/(master|[0-9\.]+-release)/react-maplibre-gl\/tree\/${BRANCH}/g" {} \; -find examples/*/src -iname "*.js" -type f -exec sed -i '' -E "s/react-maplibre-gl\/(tree|blob)\/(master|[0-9\.]+-release)/react-maplibre-gl\/tree\/${BRANCH}/g" {} \; +find docs -iname "*.md" -type f -exec sed -i '' -E "s/react-maplibre\/(tree|blob)\/(master|[0-9\.]+-release)/react-maplibre\/tree\/${BRANCH}/g" {} \; +find examples -maxdepth 0 -iname "*.md" -type f -exec sed -i '' -E "s/react-maplibre\/(tree|blob)\/(master|[0-9\.]+-release)/react-maplibre\/tree\/${BRANCH}/g" {} \; +find examples/*/src -iname "*.js" -type f -exec sed -i '' -E "s/react-maplibre\/(tree|blob)\/(master|[0-9\.]+-release)/react-maplibre\/tree\/${BRANCH}/g" {} \; # Bump dependencies in examples update_dep() { FILE=$1 VERSION=$2 cat $FILE | jq ".dependencies |= . + \ - with_entries(select(.key | match(\"react-maplibre-gl\")) | .value |= \"^${VERSION}\")" > temp + with_entries(select(.key | match(\"react-maplibre\")) | .value |= \"^${VERSION}\")" > temp mv temp $FILE }