Skip to content

Commit 65acc4e

Browse files
author
Lori Krell
committed
Add section and TOC nav for best practices
1 parent c0fe245 commit 65acc4e

File tree

5 files changed

+86
-31
lines changed

5 files changed

+86
-31
lines changed

_data/toc/community.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
label: Community Resources
2+
pages:
3+
4+
- label: Resources
5+
url: /community/resources/resources.html
6+
versionless: true
7+
8+
- label: Best Practices Guide
9+
url: /community/resources/best-practices.html
10+
versionless: true
11+
#children:
12+
13+
# - label: Page Name
14+
# url: /community/resources/filename.html
15+
# versionless: true
16+
17+
- label: Multi-Repo Docs
18+
url: /community/resources/multi-repo-docs.html
19+
versionless: true
20+

community/resources/best-practices.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
group: community
3+
title: Community Best Practices Guide
4+
---
5+
6+
This section covers a broad scope of Magento best and leading practices, common solutions, and recommendations. All contributions welcomed!
7+
8+
Topics and areas include:
9+
10+
* Project Setup
11+
* Theme development (when and were to make a new theme)
12+
* Composer use (when to create a new repo)
13+
* Local environment options
14+
15+
## Additional resources
16+
17+
The DevDocs includes many other sections:
18+
19+
- [Benchmarking for Migration]({{ page.baseurl }}/migration/migration-overview-practices.html)
20+
- [Extension Development]({{ page.baseurl }}/ext-best-practices/bk-ext-best-practices.html): Covers development and design of extensions. We also recommend the [Magento Marketplace Help Center](https://marketplacesupport.magento.com/hc/en-us).
21+
- [Theme development]({{ page.baseurl }}/frontend-dev-guide/theme-best-practice.html)
22+
- [Performance]({{ page.baseurl }}/performance-best-practices/)
23+
- [Store Configuration for Commerce Cloud]({{ page.baseurl }}/cloud/configure/configure-best-practices.html)
24+
- [Deployment for Commerce Cloud]({{ page.baseurl }}/cloud/reference/discover-deploy.html)
25+
26+
## Want to contribute?
27+
28+
You can [contribute](https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md) by adding content and new topics through Pull Requests to the [DevDocs](https://github.com/magento/devdocs) repo. Save all files to the `/community/resources` directory.
29+
30+
If you need help with reviews and navigation, we can help through your submitted PRs. If you have any questions, contact us through [#DevDocs Slack](https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md) (or [join us](https://t.co/9HImUyCmyh)) or Twitter [@MagentoDevDocs](https://twitter.com/MagentoDevDocs).
31+

community/resources/multi-repo-docs.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
layout: full-width
32
group: community
43
title: Multi-Repo Docs
54
---
Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
layout: full-width
32
group: community
43
title: Community Resources
54
redirect_from:
6-
- /guides/v2.1/community/resources/index.html
7-
- /guides/v2.0/community/resources/index.html
5+
- /community/resources/index.html
86
---
97

10-
Below are links to blog posts, podcasts, presentations, and books created by members of the {% glossarytooltip cadefd6b-0e85-4a8c-909a-5f967c56d35f %}Magento{% endglossarytooltip %} community and core developers separated into popular topics.
8+
This Community collection of resources links to blog posts, podcasts, presentations, and books created by members of the {% glossarytooltip cadefd6b-0e85-4a8c-909a-5f967c56d35f %}Magento{% endglossarytooltip %} community and core developers separated into popular topics.
119

1210
New items will be added incrementally, and older links rotated out. Keep an eye on this space for the latest community resources!
1311

@@ -18,51 +16,57 @@ Does it fill gaps in our current docs and provide important information?
1816
[Let us know][1]!
1917

2018
<div class="bs-callout bs-callout-info" markdown="1">
21-
**Note:** Magento does not officially endorse any of the blogs, books, presentation, or podcasts linked below.
19+
**Note:** Magento does not officially endorse any of the linked blogs, books, presentation, or podcasts linked below.
2220
They are listed here because the content has been well received within the Magento community.
2321
</div>
2422

2523
## Best Practices
26-
This section will cover a broad scope of Magento best practices. To name a few:
27-
* Project Setup
28-
* Themeing (when and were to make a new theme)
29-
* Composer use (When to make a new repo)
30-
* Local enviroment options
3124

25+
See our collection of best and leading practices, common solutions, and more in the [Best Practices]({{ site.baseurl }}/community/resources/best-practices.html) guide. This guide is open to contributions!
26+
27+
## Community Engineering Slack
28+
29+
To connect with Magento and the Community, join us on the [Magento Community Engineering Slack](https://t.co/9HImUyCmyh). We have channels for each project. These channels are recommended for new members joining us:
30+
31+
- general: Open chat for introductions and Magento 2 questions
32+
- github: Support for GitHub issues, pull requests, and processes
33+
- devdocs: Documentation contribution support
34+
- public-backlog: Discussions of the Magento 2 backlog
3235

3336
## Magento APIs
3437

35-
* *Presentation:* [Magento 2 Integrations][2]{:target="_blank"} by Joshua Warren
36-
* *Presentation:* [Integrations with Magento, end to end story: RabbitMQ, APIs][3]{:target="_blank"} by Eugene Tulika
38+
* *Presentation:* [Magento 2 Integrations][2] by Joshua Warren
39+
* *Presentation:* [Integrations with Magento, end to end story: RabbitMQ, APIs][3] by Eugene Tulika
3740

3841
## Install/deploy
3942

40-
* *Blog post* [Magento 2 - Launch Checklist][21]{:target="_blank"} by Syed Muneeb Ul Hasan
41-
* *Presentation:* [Magento 2 Deployment: What you should know][4]{:target="_blank"} by Olga KopyLova
42-
* *Blog post* [Magento 2 deployment without the downtime][5]{:target="_blank"} by Robert Egginton
43-
* *Blog post* [Deploying Magento 2 - History & Overview][6]{:target="_blank"} by Matthias Walter
44-
* *Blog post* [Deploying Magento 2 using Capistrano][17]{:target="_blank"} by David Alger
45-
* *Blog post* [Deploying Magento 2 with Composer and Envoyer][16]{:target="_blank"} by Nick Rigby
46-
* *GitHub* [Magento 2 Docker][18]{:target="_blank"}
43+
* *Blog post* [Magento 2 - Launch Checklist][21] by Syed Muneeb Ul Hasan
44+
* *Presentation:* [Magento 2 Deployment: What you should know][4] by Olga KopyLova
45+
* *Blog post* [Magento 2 deployment without the downtime][5] by Robert Egginton
46+
* *Blog post* [Deploying Magento 2 - History & Overview][6] by Matthias Walter
47+
* *Blog post* [Deploying Magento 2 using Capistrano][17] by David Alger
48+
* *Blog post* [Deploying Magento 2 with Composer and Envoyer][16] by Nick Rigby
49+
* *GitHub* [Magento 2 Docker][18]
4750

4851
## Automated Testing
4952

50-
* *Presentation:* [Writing testable code][10]{:target="_blank"} by Vinai Kopp (**Bonus:** [Video Presentation][11]{:target="_blank"})
51-
* *Book:* [Test Driven Magento Extension Development][12]{:target="_blank"} by Allan MacGregor
52-
* *Blog post:* [Integration Tests with Magento 2][19]{:target="_blank"} by Andreas von Studnitz
53+
* *Presentation:* [Writing testable code][10] by Vinai Kopp (**Bonus:** [Video Presentation][11]{:target="_blank"})
54+
* *Book:* [Test Driven Magento Extension Development][12] by Allan MacGregor
55+
* *Blog post:* [Integration Tests with Magento 2][19] by Andreas von Studnitz
5356

5457
## Mastering Magento 2
5558

56-
* *Book:* [Magento 2 DIY][7]{:target="_blank"} by Viktor Khliupko
57-
* *Book:* [Magento 2 Cookbook][8]{:target="_blank"} by Ray Bogman and Vladimir Kerkhoff
58-
* *Presentation:* [Staging and Preview][9]{:target="_blank"} by Igor Melnykov
59-
* *Blog post:* [Introducing UI Components][13]{:target="_blank"} by Alan Storm
60-
* *Presentation:* [Micro Services][14]{:target="_blank"} by Ivan Chepurnyi
61-
* *Blog post:* [10 Practical Rules to Build High Quality Magento 2 Module][20]{:target="_blank"} by Max Pronko
59+
* *Book:* [Magento 2 DIY][7] by Viktor Khliupko
60+
* *Book:* [Magento 2 Cookbook][8] by Ray Bogman and Vladimir Kerkhoff
61+
* *Presentation:* [Staging and Preview][9] by Igor Melnykov
62+
* *Blog post:* [Introducing UI Components][13] by Alan Storm
63+
* *Presentation:* [Micro Services][14] by Ivan Chepurnyi
64+
* *Blog post:* [10 Practical Rules to Build High Quality Magento 2 Module][20] by Max Pronko
65+
* *Presentation:* [Stop Flushing the F#@king Cache, Indexing and Caching in Magento 2][22] by John Hughes
6266

6367
## Performance
6468

65-
* *Presentation:* [Premium performance with PHP 7 and Varnish][15]{:target="_blank"} by Miguel Balparda
69+
* *Presentation:* [Premium performance with PHP 7 and Varnish][15] by Miguel Balparda
6670

6771
[0]: https://github.com/DavidLambauer/awesome-magento2
6872
[1]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
@@ -86,3 +90,4 @@ This section will cover a broad scope of Magento best practices. To name a few:
8690
[19]: https://www.integer-net.com/integration-tests-with-magento-2/
8791
[20]: https://medium.com/@maxpronko/10-practical-rules-to-build-high-quality-magento-2-module-e6fe2c9461ac
8892
[21]: https://magenticians.com/magento-2-launch-checklist/
93+
[22]: https://docs.google.com/presentation/d/1NdtNz_LBxk-JsCBy8AvekZAkSPWOE0WCzE14Y9ki-5Q/mobilepresent?slide=id.g3444c1e91c_0_10

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ <h2 class="title">Magento APIs</h2>
6868
<img src="{{ site.baseurl }}/i/icons/community.svg" alt="" />
6969
<h2 class="title">Community</h2>
7070
<ul>
71+
<li><a href="{{ site.baseurl }}/community/resources/resources.html">Community Resources</a></li>
7172
<li><a href="{{ page.baseurl }}/contributor-guide/contributing.html">Contributor Guide</a></li>
7273
<li><a href="{{ page.baseurl }}/contributor-guide/contributing_dod.html">Magento Definition of Done</a></li>
7374
<li><a href="{{ site.baseurl }}/community/resources/multi-repo-docs.html">Multi-Repo Docs</a></li>
74-
<li><a href="{{ site.baseurl }}/community/resources/index.html">Community Resources</a></li>
7575
</ul>
7676
</div>
7777

0 commit comments

Comments
 (0)