Skip to content

Archived code samples

Jeff Matthews edited this page Nov 10, 2020 · 7 revisions

UPDATE: 11/9/2020 Confirmed that the magento2-samples repo is now publicly accessible. It's still archived and the samples are likely out of date, but at least links work. We should still eliminate our dependency on samples in this repo because they are no longer maintained.

The magento2-samples repo was archived as private some time in late 2020 and is no longer publicly accessible. That repo contains code samples that we reference in ~30 places in the devdocs project, which is now causing problems for readers and leading to reports like this #7958.

We've asked the internal team responsible for that repo to make the archive publicly accessible, but they declined. The code samples in the repo are outdated and may no longer work with the latest supported release line.

Proposed solution

  • Identify all references to magento2-samples in the devdocs project
  • Determine which references can be removed
  • Determine which references cannot be removed and should be replaced with embedded code samples from the repo
  • Validate that the code samples that will be embedded in devdocs work with the latest supported Magento release line (>=2.3.x)
  • Embed code samples in devdocs
  • Identify which references cannot be replaced with embedded code samples from the repo and determine next steps