Skip to content

Commit

Permalink
Merge pull request #111 from commerce-docs/ds_url-linter
Browse files Browse the repository at this point in the history
Add a linter to validate external links
  • Loading branch information
dshevtsov authored Nov 22, 2023
2 parents d9c124f + 6f99dd0 commit 48268ab
Show file tree
Hide file tree
Showing 15 changed files with 244 additions and 24 deletions.
23 changes: 17 additions & 6 deletions .remarkrc.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import remarkValidateLinks from 'remark-validate-links';
import remarkFrontmatter from 'remark-frontmatter';
import remarkLintFrontmatterSchema from 'remark-lint-frontmatter-schema';
import remarkValidateLinks from "remark-validate-links";
import remarkFrontmatter from "remark-frontmatter";
import remarkLintFrontmatterSchema from "remark-lint-frontmatter-schema";
import remarkLintNoDeadUrls from "remark-lint-no-dead-urls";

const remarkConfig = {
plugins: [
Expand All @@ -11,13 +12,23 @@ const remarkConfig = {
{
schemas: {
/* One schema for many files */
'./.github/linters/metadata.schema.yml': [
"./.github/linters/metadata.schema.yml": [
/* Support glob patterns ———v */
'./src/pages/**/*.md',
"./src/pages/**/*.md",
],
},
},
],
[
remarkLintNoDeadUrls,
{
skipUrlPatterns: [
"https://marketplacesupport.magento.com",
"https://opensource.org/",
"https://www.php.net"
]
}
],
],
};
export default remarkConfig;
export default remarkConfig;
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"remark-cli": "^10.0.1",
"remark-frontmatter": "4.0.1",
"remark-lint-frontmatter-schema": "^3.15.2",
"remark-lint-no-dead-urls": "^1.1.0",
"remark-validate-links": "^11.0.2"
},
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion src/pages/guides/sellers/copy-paste-detector.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ Implementing a solution for detecting plagiarism in source code is not a trivial

- We might incorrectly identify code fragments that follow a common pattern as duplicates. To prevent a submission from being rejected due to incorrect results, we also perform manual code review. Even with manual reviews, we can still make mistakes.

If you notice a submission that is rejected or approved based on inaccurate information from the copy paste detector, [create a Marketplace Support ticket](https://commercemarketplace-support.adobe.com/hc/en-us) so that we can resolve your case and keep our community healthy. Please specify your Submission ID in a ticket.
If you notice a submission that is rejected or approved based on inaccurate information from the copy paste detector, [create a Marketplace Support ticket](https://marketplacesupport.magento.com/hc/en-us) so that we can resolve your case and keep our community healthy. Please specify your Submission ID in a ticket.

We always welcome feedback and discussion on the [Magento Community Engineering Slack](https://magentocommeng.slack.com/archives/C7SL5CGDN) #marketplace channel.
2 changes: 1 addition & 1 deletion src/pages/guides/sellers/developer-portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ Once you're logged in, these menus appear at the top of portal front page.
|[Shared Packages](shared-packages.md)|Takes you to the Your Shared Packages page.|
|[Reports](sales.md)|[Sales](sales.md) - Takes you to your Sales reports.<br/>[Analytics](analytics.md) - Takes you to your sales Analytics reports.|
|Resources|Lists policy information and provides links to the documentation.|
|[Support](https://commercemarketplace-support.adobe.com/hc/en-us)|Opens the [Commerce Marketplace Help Center](https://commercemarketplace-support.adobe.com/hc/en-us).|
|[Support](https://marketplacesupport.magento.com/hc/en-us)|Opens the [Commerce Marketplace Help Center](https://marketplacesupport.magento.com/hc/en-us).|
|Community|Links to the Adobe Developer [Magento Open Source](https://developer.adobe.com/open/magento) page. |
|[Profile Information](profile-information.md)|Account Information<br/>Sign Out|
4 changes: 2 additions & 2 deletions src/pages/guides/sellers/installation-and-varnish-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The Installation and Varnish tests always use the latest patch version for the M

### Additional configuration

The Varnish test requires [Varnish as a caching application](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cache/varnish/config-varnish-magento.html). The test checks for the presence of the **X-EQP-Cache** HTTP header set by Varnish and analyzes its value on page loads. To complete this check, the following additional instruction must be added to the **vcl_deliver** function:
The Varnish test requires [Varnish as a caching application](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/cache/configure-varnish-commerce.html). The test checks for the presence of the **X-EQP-Cache** HTTP header set by Varnish and analyzes its value on page loads. To complete this check, the following additional instruction must be added to the **vcl_deliver** function:

```vcl
sub vcl_deliver {
Expand Down Expand Up @@ -136,6 +136,6 @@ To debug Varnish test errors, we recommend using a locally installed Commerce ve

## Troubleshooting

If the submission fails Installation and Varnish testing, and you cannot reproduce or troubleshoot the issues locally, [create a Support ticket](https://commercemarketplace-support.adobe.com/hc/en-us) to request assistance. Ensure that the relevant Submission ID is included on the ticket.
If the submission fails Installation and Varnish testing, and you cannot reproduce or troubleshoot the issues locally, [create a Support ticket](https://marketplacesupport.magento.com/hc/en-us) to request assistance. Ensure that the relevant Submission ID is included on the ticket.

We always welcome feedback and discussion on the [Magento Community Engineering Slack](https://magentocommeng.slack.com/archives/C7SL5CGDN) #marketplace channel.
4 changes: 2 additions & 2 deletions src/pages/guides/sellers/malware-scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ If the malware scan fails, check the integrity of the files you uploaded by usin

## Troubleshooting

If the malware scan fails on a valid listing, [create a Support ticket](https://commercemarketplace-support.adobe.com/hc/en-us) and describe the use case.
If the malware scan fails on a valid listing, [create a Support ticket](https://marketplacesupport.magento.com/hc/en-us) and describe the use case.

If you find any code on the [Commerce Marketplace](https://commercemarketplace.adobe.com) that looks suspicious, contact Magento immediately through the [Marketplace Support Portal](https://commercemarketplace-support.adobe.com/hc/en-us).
If you find any code on the [Commerce Marketplace](https://commercemarketplace.adobe.com) that looks suspicious, contact Magento immediately through the [Marketplace Support Portal](https://marketplacesupport.magento.com/hc/en-us).

We always welcome feedback and discussion on the [Magento Community Engineering Slack](https://magentocommeng.slack.com/archives/C7SL5CGDN) #marketplace channel.
2 changes: 1 addition & 1 deletion src/pages/guides/sellers/semantic-version-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ php magento-semver/bin/svc compare <path-to-latest-published-extension-version>

This command requires an environment with PHP version 7.2.29 or later.

If the semantic version check detects any issues, [create a support ticket](https://commercemarketplace-support.adobe.com/hc/en-us) to request assistance. Specify the relevant Submission ID in the ticket.
If the semantic version check detects any issues, [create a support ticket](https://marketplacesupport.magento.com/hc/en-us) to request assistance. Specify the relevant Submission ID in the ticket.

As the check is solely based on [Magento SemVer open source project](https://github.com/magento/magento-semver), submitting an issue or pull request on GitHub is highly recommended.

Expand Down
2 changes: 1 addition & 1 deletion src/pages/guides/sellers/submit-for-marketing-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ You must provide a thumbnail and at least two high-quality images for the image

### Support (optional)

Customers are advised to contact you directly for support, using the information that you provide. For support issues related to Commerce Marketplace, see the [Help Center](https://commercemarketplace-support.adobe.com/hc/en-us).
Customers are advised to contact you directly for support, using the information that you provide. For support issues related to Commerce Marketplace, see the [Help Center](https://marketplacesupport.magento.com/hc/en-us).

1. Under **Marketing Submission**, click **Support**.

Expand Down
2 changes: 1 addition & 1 deletion src/pages/guides/sellers/submit-for-technical-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ All products and services are subject to the same Commerce Marketplace terms and
|Field|Description|
|--- |--- |
|Adobe Commerce Version Compatibility|Specifies each version of Commerce the listing supports.|
|License Type|Identifies the license type that defines the terms of use. To learn more, see the Open Source Initiative's Licenses by Name. Options: <br/>**Custom License** - To use a custom license, enter the Name of the license and the License URL, where customers can read the terms of use. <br/>**Academic Free License 3.0** - The [Academic Free License 3.0](https://opensource.org/licenses/AFL-3.0) (AFL) is an open source license that permits the free distribution and reuse of proprietary software and derivative works, provided that the source code is made available. <br/>**Apache License 2.0** - The [Apache License](http://www.apache.org/licenses/LICENSE-2.0) 2.0 describes the terms of use, reproduction, and distribution of third-party software products that include portions of Apache software. It requires clear attribution to The Apache Software Foundation for any distributions that include Apache software. <br/>**BSD 2-Clause License** - The [Berkeley Software Distribution 2-Clause License](https://opensource.org/licenses/BSD-2-Clause) requires the copyright notice to appear in all source code, but imposes minimal restrictions on the redistribution of open source software. The 2-clause license was derived from the original four-clause BSD license which requires a notice to appear in all advertising and prohibits the use of the contributor names in endorsements without prior written permission. <br/>**GNU General Public License 3.0** - The [GNU General Public License 3.0](http://www.gnu.org/licenses/quick-guide-gplv3.html) (GLP-3.0) is widely used and based on the GNU open source license, and allows for the redistribution of software received from the copyright holder within the provisions outlined in the agreement. Any improved version of the software must be made available for free. To learn more, see [Frequently Asked Questions about GNU Licenses](https://www.gnu.org/licenses/gpl-faq.html#AllCompatibility). <br/>**GNU Lesser General Public License 3.0** - The [GNU Lesser General Public License 3.0](http://www.gnu.org/licenses/lgpl-3.0.en.html) (LGPL-3.0) is widely used and based on the GNU open source license. LGPL-3.0 is somewhat less restrictive than the standard GLP-3.0, and also requires that you provide installation instructions. To learn more, see [Frequently Asked Questions about GNU Licenses](https://www.gnu.org/licenses/gpl-faq.html#AllCompatibility). <br/>**MIT License** - The [Massachusetts Institute of Technology License](https://opensource.org/licenses/MIT) (MIT) allows for the reuse, modification, distribution, sub-licensing, and sale of proprietary software, provided that all copies include the MIT license and copyright notice. <br/>**Mozilla Public License 1.1** - The [Mozilla Public License 1.1](https://www.mozilla.org/en-US/MPL/1.1)) (MPL-1.1) is an open source license that includes explicit patent rights and allows extensions of the code to be licensed in non-open ways. There is no requirement for a derivative work to be distributed under the same license. <br/>**Open Software License 3.0** - The [Open Software License 3.0](https://opensource.org/licenses/OSL-3.0) (OSL-3.0) is a worldwide, royalty-free, non-exclusive license that allows sub-licensing and derivative work, provided that they are distributed under the same license.|
|License Type|Identifies the license type that defines the terms of use. To learn more, see the Open Source Initiative's Licenses by Name. Options: <br/>**Custom License** - To use a custom license, enter the Name of the license and the License URL, where customers can read the terms of use. <br/>**Academic Free License 3.0** - The [Academic Free License 3.0](https://opensource.org/license/afl-3-0-php/) (AFL) is an open source license that permits the free distribution and reuse of proprietary software and derivative works, provided that the source code is made available. <br/>**Apache License 2.0** - The [Apache License](http://www.apache.org/licenses/LICENSE-2.0) 2.0 describes the terms of use, reproduction, and distribution of third-party software products that include portions of Apache software. It requires clear attribution to The Apache Software Foundation for any distributions that include Apache software. <br/>**BSD 2-Clause License** - The [Berkeley Software Distribution 2-Clause License](https://opensource.org/license/bsd-2-clause/) requires the copyright notice to appear in all source code, but imposes minimal restrictions on the redistribution of open source software. The 2-clause license was derived from the original four-clause BSD license which requires a notice to appear in all advertising and prohibits the use of the contributor names in endorsements without prior written permission. <br/>**GNU General Public License 3.0** - The [GNU General Public License 3.0](http://www.gnu.org/licenses/quick-guide-gplv3.html) (GLP-3.0) is widely used and based on the GNU open source license, and allows for the redistribution of software received from the copyright holder within the provisions outlined in the agreement. Any improved version of the software must be made available for free. To learn more, see [Frequently Asked Questions about GNU Licenses](https://www.gnu.org/licenses/gpl-faq.html#AllCompatibility). <br/>**GNU Lesser General Public License 3.0** - The [GNU Lesser General Public License 3.0](http://www.gnu.org/licenses/lgpl-3.0.en.html) (LGPL-3.0) is widely used and based on the GNU open source license. LGPL-3.0 is somewhat less restrictive than the standard GLP-3.0, and also requires that you provide installation instructions. To learn more, see [Frequently Asked Questions about GNU Licenses](https://www.gnu.org/licenses/gpl-faq.html#AllCompatibility). <br/>**MIT License** - The [Massachusetts Institute of Technology License](https://opensource.org/license/mit/) (MIT) allows for the reuse, modification, distribution, sub-licensing, and sale of proprietary software, provided that all copies include the MIT license and copyright notice. <br/>**Mozilla Public License 1.1** - The [Mozilla Public License 1.1](https://www.mozilla.org/en-US/MPL/1.1)) (MPL-1.1) is an open source license that includes explicit patent rights and allows extensions of the code to be licensed in non-open ways. There is no requirement for a derivative work to be distributed under the same license. <br/>**Open Software License 3.0** - The [Open Software License 3.0](https://opensource.org/license/osl-3-0-php/) (OSL-3.0) is a worldwide, royalty-free, non-exclusive license that allows sub-licensing and derivative work, provided that they are distributed under the same license.|
|Documents|Upload your customer-facing documentation in PDF format. The user guide is required, and you can optionally include a reference manual and installation guide. Maximum file size: 5 MB File type: PDF <br/>**User Guide** - Your extension or app must include one user guide. <br/>**Reference Manual** - (Optional) <br/>**Installation Guide** - (Optional) <br/>**_Note:_** Although the installation guide is optional, it might be required by some license types.|
|Release Notes|The preliminary Release Notes text can include simple HTML, without CSS. Maximum characters: 10,000|
|[Shared Packages](shared-packages.md)|If applicable, identifies each shared package that is required by this extension.|
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ You can request a refund within 25 days of the initial purchase payment. After t

You can re-subscribe to a cancelled extension subscription once. If you decide to cancel the subscription for a second time, you will not be able to re-subscribe to that SKU.

Thank you for using the Adobe Commerce Marketplace. For all questions and suggestions regarding extension subscriptions, please contact [Marketplace Support](https://commercemarketplace-support.adobe.com) or find us in the [Community Slack workspace](https://developer.adobe.com/open/magento/slack).
Thank you for using the Adobe Commerce Marketplace. For all questions and suggestions regarding extension subscriptions, please contact [Marketplace Support](htthttps://marketplacesupport.magento.com/) or find us in the [Community Slack workspace](https://developer.adobe.com/open/magento/slack).
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ To learn more about buying or selling subscription-licensed extensions, visit:
- [Buying Subscription-based Extensions](../subscriptions/buying-subscriptions.md)
- [Selling Subscription-based Extensions](../subscriptions/selling-subscriptions.md)

Thank you for using the Adobe Commerce Marketplace. For all questions and suggestions regarding extension subscriptions, please contact [Marketplace Support](https://commercemarketplace-support.adobe.com) or find us in the [Community Slack workspace](https://developer.adobe.com/open/magento/slack).
Thank you for using the Adobe Commerce Marketplace. For all questions and suggestions regarding extension subscriptions, please contact [Marketplace Support](https://marketplacesupport.magento.com/) or find us in the [Community Slack workspace](https://developer.adobe.com/open/magento/slack).
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ Customers can cancel their extension subscription at any time.

Customers can only re-subscribe to a cancelled extension subscription once. Repeated cancellations and re-subscriptions to an extension are not supported.

Thank you for using the Adobe Commerce Marketplace. For all questions and suggestions regarding extension subscriptions, please contact [Marketplace Support](https://commercemarketplace-support.adobe.com) or find us in the [Community Slack workspace](https://developer.adobe.com/open/magento/slack).
Thank you for using the Adobe Commerce Marketplace. For all questions and suggestions regarding extension subscriptions, please contact [Marketplace Support](https://marketplacesupport.magento.com/) or find us in the [Community Slack workspace](https://developer.adobe.com/open/magento/slack).
2 changes: 1 addition & 1 deletion src/pages/guides/sellers/technical-review-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ _See also:_ [Coding Standards](https://developer.adobe.com/commerce/php/coding-s

All code and marketing content that is submitted to Commerce Marketplace is checked for plagiarism to ensure that it has not been copied from existing Marketplace extensions or from the Commerce codebase.

If the extension contains source code from the Open Source Edition, the extension must be licensed under [Open Source License v. 3.0](https://opensource.org/licenses/OSL-3.0) and properly credit Adobe, Inc.
If the extension contains source code from the Open Source Edition, the extension must be licensed under [Open Source License v. 3.0](https://opensource.org/license/osl-3-0-php/) and properly credit Adobe, Inc.

_More details:_ [Copy Paste Detector](copy-paste-detector.md)

Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Provides programmatic access to the Commerce Developer Portal.

<DiscoverBlock slots="link, text"/>

[Support](https://commercemarketplace-support.adobe.com/hc/en-us)
[Support](https://marketplacesupport.magento.com/hc/en-us)

Search the Commerce Marketplace Help Center knowledge base or submit a support ticket.

Expand Down
Loading

0 comments on commit 48268ab

Please sign in to comment.