Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Latest commit

 

History

History
33 lines (21 loc) · 1.4 KB

best-practice-template.md

File metadata and controls

33 lines (21 loc) · 1.4 KB
title labels
Best practice for...
best-practice, ...

Title: Use "Best practice" in title and keep it short, maximum 70 characters is preferred.
(Example: "Best practice for OPcache memory size Adobe Commerce 2.3.x")

Intro: It is a best practice to... Intro should be a paragraph or two. The first 140 characters are important for SEO purposes.

Or you can use "This article talks about..." if relevant.

Affected products and versions

  • Adobe Commerce on-premises x.x.x
  • Adobe Commerce on cloud infrastructure x.x.x

Alternatively if the same versions on cloud or on-premises are affected you can say:

Adobe Commerce (all deployment methods) x.x.x

  • Affected extension or technology (e.g. Redis, Fastly): x.x.x

Best practice

...

Related reading

  • Article topic in our user guide.
  • Article topic in our developer documentation. You can also say to differentiate between instructions in devdocs for cloud vs on-premises users: “Article topic in our developer documentation for Adobe Commerce on cloud infrastructure." vs "Article topic in our developer documentation for Adobe Commerce on-premises."
  • Article topic in our support knowledge base.
  • Any related resources (blogs, forums, StackOverflow, etc.)