Skip to content

Commit 51b9f33

Browse files
jeff-matthewsjeff-matthews
authored
Consolidate devdocs and engcomm contributors/maintainers (magento#2074)
* Add contributors widget * Move contributors topics * Moved definition of done topic to the code contributions section * Remove hrefs to old files, update github file links * Revised and added content from EngComm Added text for maintainers Removed previous content Revised and added formatting * Editorial revisions to maintainers rewrite * Add survey code and put back the devdocs.js
1 parent 78ec537 commit 51b9f33

19 files changed

+92
-321
lines changed

Diff for: ‎_data/toc/contributor-guide.yml

+15-15
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ pages:
55
url: /contributor-guide/contributing.html
66

77
children:
8+
- label: Magento Definition of Done
9+
url: /contributor-guide/contributing_dod.html
10+
811
- label: Backward compatible development
912
url: /contributor-guide/backward-compatible-development
1013

@@ -13,24 +16,21 @@ pages:
1316
- label: Contribution Guidelines
1417
url: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
1518

16-
- label: Magento Definition of Done
17-
url: /contributor-guide/contributing_dod.html
18-
1919
- label: Suggested topics for contribution
2020
url: /contributor-guide/contributing_docs_suggested.html
2121

22-
- label: DevDocs Contributors
23-
url: /contributor-guide/quarterly-contributors.html
22+
- label: Templates
23+
children:
24+
- label: Basic template
25+
url: /contributor-guide/templates/basic_template.html
2426

25-
- label: Community Maintainers
26-
url: /contributor-guide/devdocs-maintainers.html
27-
versions: ["2.1","2.2","2.3"]
27+
- label: Sample template tutorial
28+
class: tutorial
29+
url: /contributor-guide/templates/tutorial-template-first.html
2830

29-
- label: Templates
30-
children:
31-
- label: Basic template
32-
url: /contributor-guide/templates/basic_template.html
31+
- label: Contributors
32+
url: /contributor-guide/contributors.html
3333

34-
- label: Sample template tutorial
35-
class: tutorial
36-
url: /contributor-guide/templates/tutorial-template-first.html
34+
- label: Maintainers
35+
url: /contributor-guide/maintainers.html
36+
versions: ["2.1","2.2","2.3"]

Diff for: ‎_includes/home/contributors.html

+2-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
<section class="home-contributors">
2-
<div class="container">
3-
4-
<h2>Top Monthly Contributors</h2>
5-
6-
<p class="intro">
7-
Our documentation is open-source on GitHub. Even the smallest of edits are appreciated, as are enhancements and clarifications to our existing content. We love when we get complete new topics from our community members! See <a href="{{ page.baseurl }}/contributor-guide/quarterly-contributors.html">all contributors</a>.
8-
</p>
9-
10-
<div class="devdocs-contributors" data-contributors-limit="5" data-period-types="monthly"></div>
11-
12-
<div class="home-contributors-buttons">
13-
<a href="https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md" class="btn btn-large btn-primary">Become a Contributor</a>
14-
</div>
15-
2+
<div class="container application-wrapper">
3+
<div id="root"></div>
164
</div>
175
</section><!-- END home-contributors -->

Diff for: ‎_includes/layout/footer-scripts.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<script src="{{ site.baseurl }}/common/js/devdocs.min.js"></script>
2+
<script src="https://statistic.engcom.magento.com/magento.com/application.min.js"></script>
23

34
{% if site.environment == "public" %}
45

@@ -25,4 +26,4 @@
2526
})();
2627
</script>
2728

28-
{% endif %}
29+
{% endif %}

Diff for: ‎common/js/devdocs.min.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎guides/v2.0/contributor-guide/contributors.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
group: contributor
3+
title: Contributors
4+
version: 2.1
5+
github_link: contributor-guide/contributors.md
6+
redirect_from:
7+
- guides/v2.0/howdoi/howdoi_bios.html
8+
- guides/v2.0/contributor-guide/quarterly-contributors.html
9+
---
10+
11+
Thanks to the following community members, partners, and Magento fans who contribute to Magento's open source projects.
12+
13+
{% include home/contributors.html %}

Diff for: ‎guides/v2.0/howdoi/howdoi_contribute.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ menu_order: 1
99

1010
Please sign up to write a How Do I topic for us!
1111

12-
We'll put your name (or company's name) at the top of the page, right under the title, and link it to your blog or website! And you'll get your face and bio in the <a href="{{ page.baseurl }}/contributor-guide/quarterly-contributors.html">ring of honor</a> as one of our featured contributors.
12+
We'll put your name (or company's name) at the top of the page, right under the title, and link it to your blog or website! Your GitHub avatar will also appear on the [Contributors]({{page.baseurl}}/contributor-guide/contributors.html) page.
1313

14-
To add your name to this table, all you need to do is to submit a <a href="{{ site.githuburl }}howdoi/howdoi_contribute.md">pull request on this page</a> or <a href="mailto:DL-Magento-Doc-Feedback@magento.com">e-mail us</a>.
14+
To add your name to this table, all you need to do is [submit a pull request]({{site.githuburl}}howdoi/howdoi_contribute.md) on this page.
1515

16-
Use <a href="{{ page.baseurl }}/howdoi/howdoi_template.html">this template</a> if you'd like. You can get a copy of the <a href="{{ site.githuburl }}howdoi/howdoi_template.md">.md file on Github</a>.
16+
You can use [this template]({{page.baseurl}}/howdoi/howdoi_template.html). You can get a copy of the [markdown file]({{site.githuburl}}howdoi/howdoi_template.md) on Github.
1717

1818
Submissions should be {% glossarytooltip a5ef9041-976f-4eb3-826e-bf836027d8c3 %}Markdown{% endglossarytooltip %} but {% glossarytooltip a2aff425-07dd-4bd6-9671-29b7edefa871 %}HTML{% endglossarytooltip %} is welcome also.
1919

Diff for: ‎guides/v2.1/contributor-guide/contributors.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
group: contributor
3+
title: Contributors
4+
version: 2.1
5+
github_link: contributor-guide/contributors.md
6+
redirect_from:
7+
- guides/v2.0/howdoi/howdoi_bios.html
8+
- guides/v2.1/contributor-guide/quarterly-contributors.html
9+
- guides/v2.2/contributor-guide/quarterly-contributors.html
10+
- guides/v2.3/contributor-guide/quarterly-contributors.html
11+
---
12+
13+
Thanks to the following community members, partners, and Magento fans who contribute to Magento's open source projects.
14+
15+
{% include home/contributors.html %}

Diff for: ‎guides/v2.1/contributor-guide/maintainers.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
group: contributor
3+
title: Maintainers
4+
version: 2.1
5+
github_link: contributor-guide/maintainers.md
6+
redirect_from:
7+
- guides/v2.1/contributor-guide/devdocs-maintainers.html
8+
- guides/v2.2/contributor-guide/devdocs-maintainers.html
9+
- guides/v2.3/contributor-guide/devdocs-maintainers.html
10+
---
11+
12+
Magento trusts our active community members to review pull requests and accept or reject proposed code changes. [Community Maintainers](https://magento.com/magento-contributors#maintainers){:target="\_blank"} take part in discussions, reviews, and help process pull requests.
13+
14+
## Who becomes a Maintainer?
15+
16+
When considering new maintainers, we look for contributors who have shown a propensity for:
17+
18+
- Contributing good and accepted code to multiple Magento projects, including fixes for issues and new features
19+
- Participating in discussions in our development projects, including the [architecture](https://github.com/magento/architecture){:target="\_blank"} and [backlog](https://github.com/magento/backlog){:target="\_blank"} projects
20+
- Reviewing and discussing pull requests from other contributors
21+
- Helping other contributors with complex decisions and questions, like architecture questions, and providing advice according to [Magento technical guidelines]({{ page.baseurl }}/coding-standards/technical-guidelines.html)
22+
23+
## Maintainer activities
24+
25+
Maintainers take part in these main activities:
26+
27+
- Review pull request descriptions to make sure that they are meaningful and contain all required details; expedites pull request delivery without requiring additional clarification from contributors
28+
- Review pull requests according to [Magento technical guidelines]({{ page.baseurl }}/coding-standards/technical-guidelines.html)
29+
- Avoid [backward incompatible changes]({{ page.baseurl }}/contributor-guide/backward-compatible-development/) in proposed changes
30+
- Make sure all new code is covered with appropriate unit, integration, and functional tests
31+
- Review issue descriptions to make sure that they are meaningful and provide clear reproduction steps
32+
- Participate in discussions regarding proposed solutions, created issues, and more
33+
- Help other community members resolve their questions and issues with advice, helpful code snippets, or other examples
34+
- Find and propose better or new methods for pull request reviews, code delivery, QA activities, tests, and more

Diff for: ‎guides/v2.1/howdoi/howdoi_contribute.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ menu_order: 1
99

1010
Please sign up to write a How Do I topic for us!
1111

12-
We'll put your name (or company's name) at the top of the page, right under the title, and link it to your blog or website! And you'll get your face and bio in the <a href="{{ page.baseurl }}/contributor-guide/quarterly-contributors.html">ring of honor</a> as one of our featured contributors.
12+
We'll put your name (or company's name) at the top of the page, right under the title, and link it to your blog or website! Your GitHub avatar will also appear on the [Contributors]({{page.baseurl}}/contributor-guide/contributors.html) page.
1313

14-
To add your name to this table, all you need to do is to submit a <a href="{{ site.githuburl }}howdoi/howdoi_contribute.md">pull request on this page</a> or <a href="mailto:DL-Magento-Doc-Feedback@magento.com">e-mail us</a>.
14+
To add your name to this table, all you need to do is [submit a pull request]({{site.githuburl}}howdoi/howdoi_contribute.md) on this page.
1515

16-
Use <a href="{{ page.baseurl }}/howdoi/howdoi_template.html">this template</a> if you'd like. You can get a copy of the <a href="{{ site.githuburl }}howdoi/howdoi_template.md">.md file on Github</a>.
16+
You can use [this template]({{page.baseurl}}/howdoi/howdoi_template.html). You can get a copy of the [markdown file]({{site.githuburl}}howdoi/howdoi_template.md) on Github.
1717

1818
Submissions should be {% glossarytooltip a5ef9041-976f-4eb3-826e-bf836027d8c3 %}Markdown{% endglossarytooltip %} but {% glossarytooltip a2aff425-07dd-4bd6-9671-29b7edefa871 %}HTML{% endglossarytooltip %} is welcome also.
1919

Diff for: ‎guides/v2.2/contributor-guide/contributors.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../v2.1/contributor-guide/contributors.md

Diff for: ‎guides/v2.2/contributor-guide/devdocs-maintainers.md

-1
This file was deleted.

Diff for: ‎guides/v2.2/contributor-guide/maintainers.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../v2.1/contributor-guide/maintainers.md

Diff for: ‎guides/v2.2/contributor-guide/quarterly-contributors.md

-1
This file was deleted.

Diff for: ‎guides/v2.3/contributor-guide/contributors.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../v2.2/contributor-guide/contributors.md

Diff for: ‎guides/v2.3/contributor-guide/devdocs-maintainers.md

-1
This file was deleted.

Diff for: ‎guides/v2.3/contributor-guide/maintainers.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../v2.2/contributor-guide/maintainers.md

Diff for: ‎guides/v2.3/contributor-guide/quarterly-contributors.md

-1
This file was deleted.

0 commit comments

Comments
 (0)