From c3702be9d4e5d603041c87097a1b9c38f345386a Mon Sep 17 00:00:00 2001 From: Evan Rusackas Date: Mon, 29 Jul 2024 16:19:42 -0600 Subject: [PATCH] docs: Check markdown files for bad links using linkinator (#28424) --- .github/workflows/superset-docs-verify.yml | 10 ++++++++++ CODE_OF_CONDUCT.md | 4 ++-- RELEASING/README.md | 2 +- RELEASING/release-notes-1-0/README.md | 4 ++-- RELEASING/release-notes-1-5/README.md | 2 +- RESOURCES/FEATURE_FLAGS.md | 4 ++-- RESOURCES/INTHEWILD.md | 22 ++++++++-------------- UPDATING.md | 5 +++-- docs/docs/contributing/guidelines.mdx | 2 +- 9 files changed, 30 insertions(+), 25 deletions(-) diff --git a/.github/workflows/superset-docs-verify.yml b/.github/workflows/superset-docs-verify.yml index de82268e0..1f32c00d7 100644 --- a/.github/workflows/superset-docs-verify.yml +++ b/.github/workflows/superset-docs-verify.yml @@ -12,6 +12,16 @@ concurrency: cancel-in-progress: true jobs: + linkinator: + name: Link Checking + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: JustinBeckwith/linkinator-action@v1.10.4 + with: + paths: "**/*.md, **/*.mdx" + linksToSkip: '^https://github.com/apache/(superset|incubator-superset)/(pull|issue)/\d+, http://localhost:8088/, docker/.env-non-dev, http://127.0.0.1:3000/, http://localhost:9001/, https://charts.bitnami.com/bitnami, https://www.li.me/, https://www.fanatics.com/, https://tails.com/gb/, https://www.techaudit.info/, https://avetilearning.com/, https://www.udemy.com/, https://trustmedis.com/, http://theiconic.com.au/, https://dev.mysql.com/doc/refman/5.7/en/innodb-limits.html, https://img.shields.io/librariesio/release/npm/%40superset-ui%2Fembedded-sdk?style=flat, https://img.shields.io/librariesio/release/npm/%40superset-ui%2Fplugin-chart-pivot-table?style=flat, https://vkusvill.ru/' + # verbosity: 'ERROR' build-deploy: name: Build & Deploy runs-on: ubuntu-22.04 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 59795d5f8..c2e504e3a 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -94,9 +94,9 @@ This statement thanks the following, on which it draws for content and inspirati * [CouchDB Project Code of conduct](http://couchdb.apache.org/conduct.html) * [Fedora Project Code of Conduct](http://fedoraproject.org/code-of-conduct) -* [Speak Up! Code of Conduct](http://speakup.io/coc.html) +* [Speak Up! Code of Conduct](http://web.archive.org/web/20141109123859/http://speakup.io/coc.html) * [Django Code of Conduct](https://www.djangoproject.com/conduct/) -* [Debian Code of Conduct](http://www.debian.org/vote/2014/vote_002) +* [Debian Code of Conduct](https://www.debian.org/vote/2014/vote_002) * [Twitter Open Source Code of Conduct](https://github.com/twitter/code-of-conduct/blob/master/code-of-conduct.md) * [Mozilla Code of Conduct/Draft](https://wiki.mozilla.org/Code_of_Conduct/Draft#Conflicts_of_Interest) * [Python Diversity Appendix](https://www.python.org/community/diversity/) diff --git a/RELEASING/README.md b/RELEASING/README.md index 39e4177ac..4145c807d 100644 --- a/RELEASING/README.md +++ b/RELEASING/README.md @@ -505,7 +505,7 @@ We also need to update the Environment section of [ISSUE_TEMPLATE/bug-report.yml Docker release with proper tags should happen automatically as version tags get pushed to the `apache/superset` GitHub repository through this -[GitHub action](https://github.com/apache/superset/blob/master/.github/workflows/docker-release.yml) +[GitHub action](https://github.com/apache/superset/blob/master/.github/workflows/docker.yml) Note that this GH action implements a `workflow_dispatch` trigger, meaning that it can be triggered manually from the GitHub UI. If anything diff --git a/RELEASING/release-notes-1-0/README.md b/RELEASING/release-notes-1-0/README.md index ed1eeea0d..6379bf099 100644 --- a/RELEASING/release-notes-1-0/README.md +++ b/RELEASING/release-notes-1-0/README.md @@ -102,7 +102,7 @@ Some of the new features in this release are disabled by default. Each has a fea This release includes **hundreds** of bugfixes and stability enhancements. Future major releases will have a continued emphasis on providing a stable and bug-free experience for the user. # PR Highlights -Below is a highlight of the PRs included in this update. The full list is much longer, and can be found [here](apache/incubator-superset/CHANGELOG.md). +Below is a highlight of the PRs included in this update. The full list is much longer, and can be found [here](https://github.com/apache/superset/blob/master/CHANGELOG.md). ## User Experience - Revert "refactor: Remove usages of reactable from TimeTable (#11046)" (#[11150](https://github.com/apache/incubator-superset/pull/11150)) @@ -222,4 +222,4 @@ Below is a highlight of the PRs included in this update. The full list is much l ## Complete Changelog Backwards incompatible changes and can be found [here](../../UPDATING.md). -To see the complete changelog, see [apache/incubator-superset/CHANGELOG.md](https://github.com/apache/superset/blob/master/CHANGELOG.md) +To see the complete changelog, see [apache/superset/CHANGELOG.md](https://github.com/apache/superset/blob/master/CHANGELOG.md) diff --git a/RELEASING/release-notes-1-5/README.md b/RELEASING/release-notes-1-5/README.md index 44cba5b89..74389e8c7 100644 --- a/RELEASING/release-notes-1-5/README.md +++ b/RELEASING/release-notes-1-5/README.md @@ -137,6 +137,6 @@ when available. **Changelog** To see the complete changelog in this release, head to -[CHANGELOG.MD](https://github.com/apache/superset/blob/1.5/CHANGELOG/1.5.0.md). +[CHANGELOG.MD](https://github.com/apache/superset/blob/master/CHANGELOG/1.5.0.md). As mentioned earlier, this release has a MASSIVE amount of bug fixes. The full changelog lists all of them! diff --git a/RESOURCES/FEATURE_FLAGS.md b/RESOURCES/FEATURE_FLAGS.md index 2c4d4d0c3..57037d879 100644 --- a/RESOURCES/FEATURE_FLAGS.md +++ b/RESOURCES/FEATURE_FLAGS.md @@ -45,7 +45,7 @@ These features are **finished** but currently being tested. They are usable, but - CACHE_IMPERSONATION - CONFIRM_DASHBOARD_DIFF - DRILL_TO_DETAIL -- DYNAMIC_PLUGINS: [(docs)](https://superset.apache.org/docs/configuration/running-on-kubernetes) +- DYNAMIC_PLUGINS - ENABLE_SUPERSET_META_DB: [(docs)](https://superset.apache.org/docs/configuration/databases/#querying-across-databases) - ESTIMATE_QUERY_COST - GLOBAL_ASYNC_QUERIES [(docs)](https://github.com/apache/superset/blob/master/CONTRIBUTING.md#async-chart-queries) @@ -70,7 +70,7 @@ These features flags are **safe for production**. They have been tested and will ### Flags retained for runtime configuration - ALERTS_ATTACH_REPORTS - ALLOW_ADHOC_SUBQUERY -- DASHBOARD_RBAC [(docs)](https://superset.apache.org/docs/using-superset/first-dashboard#manage-access-to-dashboards) +- DASHBOARD_RBAC [(docs)](https://superset.apache.org/docs/using-superset/creating-your-first-dashboard#manage-access-to-dashboards) - DATAPANEL_CLOSED_BY_DEFAULT - DRUID_JOINS - EMBEDDABLE_CHARTS diff --git a/RESOURCES/INTHEWILD.md b/RESOURCES/INTHEWILD.md index 67c5e9f07..50f8acc60 100644 --- a/RESOURCES/INTHEWILD.md +++ b/RESOURCES/INTHEWILD.md @@ -30,7 +30,7 @@ Join our growing community! - [Airbnb](https://github.com/airbnb) - [Faasos](http://faasos.com/) [@shashanksingh] - [Hostnfly](https://www.hostnfly.com/) [@alexisrosuel] -- [Lime](https://www.limebike.com/) [@cxmcc] +- [Lime](https://www.li.me/) [@cxmcc] - [Lyft](https://www.lyft.com/) - [Ontruck](https://www.ontruck.com/) @@ -47,7 +47,6 @@ Join our growing community! - [bumper](https://www.bumper.co/) [@vasu-ram, @JamiePercival] ### Gaming -- [Digit Game Studios](https://www.digitgaming.com/) - [Popoko VM Games Studio](https://popoko.live) ### E-Commerce @@ -55,7 +54,7 @@ Join our growing community! - [Bazaar Technologies](https://www.bazaartech.com) [@umair-abro] - [Dragonpass](https://www.dragonpass.com.cn/) [@zhxjdwh] - [Dropit Shopping](https://www.dropit.shop/) [@dropit-dev] -- [Fanatics](https://www.fanatics.com) [@coderfender] +- [Fanatics](https://www.fanatics.com/) [@coderfender] - [Fordeal](http://www.fordeal.com) [@Renkai] - [GFG - Global Fashion Group](https://global-fashion-group.com) [@ksaagariconic] - [HuiShouBao](http://www.huishoubao.com/) [@Yukinoshita-Yukino] @@ -64,10 +63,10 @@ Join our growing community! - [Rakuten Viki](https://www.viki.com) - [Shopee](https://shopee.sg) [@xiaohanyu] - [Shopkick](https://www.shopkick.com) [@LAlbertalli] -- [Tails.com](https://tails.com) [@alanmcruickshank] +- [Tails.com](https://tails.com/gb/) [@alanmcruickshank] - [THE ICONIC](http://theiconic.com.au/) [@ksaagariconic] - [Utair](https://www.utair.ru) [@utair-digital] -- [VkusVill](https://www.vkusvill.ru) [@ETselikov] +- [VkusVill](https://vkusvill.ru/) [@ETselikov] - [Zalando](https://www.zalando.com) [@dmigo] - [Zalora](https://www.zalora.com) [@ksaagariconic] @@ -89,8 +88,7 @@ Join our growing community! - [Endress+Hauser](http://www.endress.com/) [@rumbin] - [FBK - ICT center](http://ict.fbk.eu) - [Gavagai](https://gavagai.io) [@gavagai-corp] -- [GfK Data Lab](http://datalab.gfk.com) [@mherr] -- [GrowthSimple](https://growthsimple.ai/) +- [GfK Data Lab](https://www.gfk.com/home) [@mherr] - [Hydrolix](https://www.hydrolix.io/) - [Intercom](https://www.intercom.com/) [@kate-gallo] - [jampp](https://jampp.com/) @@ -105,17 +103,14 @@ Join our growing community! - [Peak AI](https://www.peak.ai/) [@azhar22k] - [PeopleDoc](https://www.people-doc.com) [@rodo] - [Preset, Inc.](https://preset.io) -- [Pronto Tools](http://www.prontotools.io) [@zkan] - [PubNub](https://pubnub.com) [@jzucker2] - [ReadyTech](https://www.readytech.io) - [Reward Gateway](https://www.rewardgateway.com) - [ScopeAI](https://www.getscopeai.com) [@iloveluce] -- [Showmax](https://tech.showmax.com) [@bobek] -- [source{d}](https://www.sourced.tech) [@marnovo] -- [Steamroot](https://streamroot.io/) +- [Showmax](https://showmax.com) [@bobek] - [TechAudit](https://www.techaudit.info) [@ETselikov] - [Tenable](https://www.tenable.com) [@dflionis] -- [Tentacle](https://public.tentaclecmi.com) [@jdclarke5] +- [Tentacle](https://tentaclecmi.com) [@jdclarke5] - [timbr.ai](https://timbr.ai/) [@semantiDan] - [Tobii](http://www.tobii.com/) [@dwa] - [Tooploox](https://www.tooploox.com/) [@jakubczaplicki] @@ -155,14 +150,13 @@ Join our growing community! ### Healthcare - [Amino](https://amino.com) [@shkr] -- [Beans](https://www.beans.fi) [@kakoni] - [Bluesquare](https://www.bluesquarehub.com/) [@madewulf] - [Care](https://www.getcare.io/)[@alandao2021] - [Living Goods](https://www.livinggoods.org) [@chelule] - [Maieutical Labs](https://maieuticallabs.it) [@xrmx] - [QPID Health](http://www.qpidhealth.com/) - [REDCap Cloud](https://www.redcapcloud.com/) -- [TrustMedis](https://trustmedis.com) [@famasya] +- [TrustMedis](https://trustmedis.com/) [@famasya] - [WeSure](https://www.wesure.cn/) ### HR / Staffing diff --git a/UPDATING.md b/UPDATING.md index f1ccbbdc0..e7c376afe 100644 --- a/UPDATING.md +++ b/UPDATING.md @@ -227,7 +227,8 @@ assists people when migrating to a new version. - [19273](https://github.com/apache/superset/pull/19273): The `SUPERSET_CELERY_WORKERS` and `SUPERSET_WORKERS` config keys has been removed. Configure Celery directly using `CELERY_CONFIG` on Superset. - [19231](https://github.com/apache/superset/pull/19231): The `ENABLE_REACT_CRUD_VIEWS` feature flag has been removed (permanently enabled). Any deployments which had set this flag to false will need to verify that the React views support their use case. - [19230](https://github.com/apache/superset/pull/19230): The `ROW_LEVEL_SECURITY` feature flag has been removed (permanently enabled). Any deployments which had set this flag to false will need to verify that the presence of the Row Level Security feature does not interfere with their use case. -- [19168](https://github.com/apache/superset/pull/19168): Celery upgrade to 5.X resulted in breaking changes to its command line invocation. Please follow [these](https://docs.celeryq.dev/en/stable/whatsnew-5.2.html#step-1-adjust-your-command-line-invocation) instructions for adjustments. Also consider migrating you Celery config per [here](https://docs.celeryq.dev/en/stable/userguide/configuration.html#conf-old-settings-map). +- [19168](https://github.com/apache/superset/pull/19168): Celery upgrade to 5.X resulted in breaking changes to its command line invocation. +html#step-1-adjust-your-command-line-invocation) instructions for adjustments. Also consider migrating you Celery config per [here](https://docs.celeryq.dev/en/stable/userguide/configuration.html#conf-old-settings-map). - [19142](https://github.com/apache/superset/pull/19142): The `VERSIONED_EXPORT` config key is now `True` by default. - [19113](https://github.com/apache/superset/pull/19113): The `ENABLE_JAVASCRIPT_CONTROLS` config key has moved from an app config to a feature flag. Any deployments who overrode this setting will now need to override the feature flag from here onward. - [19107](https://github.com/apache/superset/pull/19107): The `SQLLAB_BACKEND_PERSISTENCE` feature flag is now `True` by default, which enables persisting SQL Lab tabs in the backend instead of the browser's `localStorage`. @@ -538,7 +539,7 @@ assists people when migrating to a new version. - [8117](https://github.com/apache/superset/pull/8117): If you are using `ENABLE_PROXY_FIX = True`, review the newly-introduced variable, `PROXY_FIX_CONFIG`, which changes the proxy behavior in accordance with - [Werkzeug](https://werkzeug.palletsprojects.com/en/0.15.x/middleware/proxy_fix/) + Werkzeug. - [8069](https://github.com/apache/superset/pull/8069): introduces [MessagePack](https://github.com/msgpack/msgpack-python) and diff --git a/docs/docs/contributing/guidelines.mdx b/docs/docs/contributing/guidelines.mdx index 7cf24954a..1ba1e6af9 100644 --- a/docs/docs/contributing/guidelines.mdx +++ b/docs/docs/contributing/guidelines.mdx @@ -12,7 +12,7 @@ A philosophy we would like to strongly encourage is The purpose is to separate problem from possible solutions. -**Bug fixes:** If you’re only fixing a small bug, it’s fine to submit a pull request right away but we highly recommend to file an issue detailing what you’re fixing. This is helpful in case we don’t accept that specific fix but want to keep track of the issue. Please keep in mind that the project maintainers reserve the rights to accept or reject incoming PRs, so it is better to separate the issue and the code to fix it from each other. In some cases, project maintainers may request you to create a separate issue from PR before proceeding. +**Bug fixes:** If you’re only fixing a small bug, it’s fine to submit a pull request right away but we highly recommend filing an issue detailing what you’re fixing. This is helpful in case we don’t accept that specific fix but want to keep track of the issue. Please keep in mind that the project maintainers reserve the rights to accept or reject incoming PRs, so it is better to separate the issue and the code to fix it from each other. In some cases, project maintainers may request you to create a separate issue from PR before proceeding. **Refactor:** For small refactors, it can be a standalone PR itself detailing what you are refactoring and why. If there are concerns, project maintainers may request you to create a `#SIP` for the PR before proceeding.