summaryrefslogtreecommitdiffstats
path: root/source/en/extend-module-find.txt
blob: bcec8f9973c83d73d85fc8736d9d1529904e973f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
[[extend-module-find]]

=== Finding Modules

[role="summary"]
How to search and evaluate modules on Drupal.org.

(((Module,finding)))
(((Module,evaluating)))
(((Contributed module,finding)))
(((Contributed module,evaluating)))
(((Drupal.org website,finding and evaluating modules on)))

==== Goal

Find and evaluate modules on _Drupal.org_.

==== Prerequisite knowledge

* <<understanding-drupal>>
* <<understanding-modules>>

//==== Site prerequisites

==== Steps

. Go to https://www.drupal.org[_Drupal.org_], and navigate to _Download &
Extend_ > _Modules_ (https://www.drupal.org/project/project_module).

. Filter your search using the categories on the module search page.
Fill in the fields as shown below.
+
[width="100%",frame="topbot",options="header"]
|================================
|Field name |Explanation |Example value
|Maintenance status |How actively should the module be maintained? | Actively maintained
|Development status |What kind of development should the module undergo?| Any
|Module categories |The module's topic area.|Administration
|Core compatibility |The version of the core software the module is compatible with.|8.x
|Status |Project status: _Sandbox projects_ are experimental projects. _Full projects_ have
 already gone through an approval process, but they can still be in development. |Full projects
|Stability | Whether or not the project maintainer has created a production-ready version.
 |Has a supported stable release
|Security advisory coverage | Whether or not the project maintainer has agreed to follow Drupal
 Security Team procedures. |Has security advisory coverage
|Search Modules |Search for _Admin Toolbar_, a module that will be covered in detail later.
 Alternatively, you can also leave the field blank if you are not sure which module to search for.
 |Admin Toolbar
|Sort by |Order your search results by criteria like _Most installed_ (popular modules that many
 sites use) or _Last release_ (date of latest version released). |Most installed
|================================
+
--
// Module search box on https://www.drupal.org/project/project_module.
image:images/extend-module-find_module_finder.png["Filters on the module search page on _Drupal.org_"]
--

. Click _Search_. Search results will appear.
+
--
// Search results on https://www.drupal.org/project/project_module.
image:images/extend-module-find_search_results.png["Module search results page on _Drupal.org_"]
--

. To further evaluate a module, click its title in the list of search results
to visit its project page.

Some aspects to pay attention to when evaluating modules:

* Project description: The description of the module on its project page should
be clear and useful. You should get an idea of its features and requirements.

* Project information: There may be warnings in this area of the page, such as
if a module is no longer being developed, or is not covered by the security
advisory policy.

* Project information > Reported installs, downloads: You can see how many
people have downloaded and how many sites use the module. If it's only used by a
few sites, it might be a unique solution that not many people need, or it might
be a warning sign that you shouldn't use it either.

* Maintainers: When was the last commit (the last time someone updated something
on the module) or last release (new version)? If the project has few open
issues, a long time since commits/releases might be appropriate, but if it has
a lot of open issues and there are no commits/releases, that would be a clue
that it might be abandoned.

* Issues: See if there are any open issues, potential problems with the
module. Check the Statistics to see how regularly issues are responded to.

* Documentation, Resources: Check if the module has documentation or a README
file, that can help you install, configure, explore, and test it.
+
--
// Project page for Admin Toolbar module.
image:images/extend-module-find_project_info.png["Information on the project page to look for when evaluating a module", width="100%"]
--

==== Expand your understanding

<<extend-module-install>>

//==== Related concepts

==== Videos

// Video from Drupalize.Me.
video::https://www.youtube-nocookie.com/embed/G-XUuSj9xYA[title="Finding Modules"]

//==== Additional resources


*Attributions*

Written by https://www.drupal.org/u/dianalakatos[Diána Lakatos] at
https://pronovix.com//[Pronovix].