On #2148255: [meta] Make better D8 api.d.o landing page, linked to high-level overview topics, and put it in Core api.php files, we made a patch that included a stub Topic page for api.drupal.org (i.e., a @defgroup) titled:
Best Practices for Developers
This can be found in file core/modules/system/core.api.php where it says
@defgroup best_practices
The documentation to go on this page needs to be written. The idea is:
a) Write a few paragraphs about the topic.
b) Link to more detailed documentation on
https://drupal.org/developing/api/8
(or nearby sections)
c) If the more detailed documentation does not yet exist, create stub page(s), link to the stub pages, and add a note to this issue stating that the stub pages need to be filled out.
d) If the topic has related classes, interfaces, and functions -- appropriate for an overview -- add
@ingroup best_practices
to their documentation headers. That will make these classes etc. show up on the Topic page on api.drupal.org. Only include classes/functions that are appropriate for an overview page please!
For more info -- documentation standards for @defgroup/@ingroup:
https://drupal.org/coding-standards/docs#defgroup
| Comment | File | Size | Author |
|---|---|---|---|
| #1 | 2216567.patch | 2.34 KB | jhodgdon |
Comments
Comment #1
jhodgdonHere's a first pass patch. It includes a couple of URLs for other sections that I ran into when looking for what should go into this patch, so if one of those other issues gets in first, we'll need to reroll.
Comment #2
jayeshanandani commentedPatch submitted looks good. Replaced with much more informative text. All links appear to redirect correctly. RTBC!
Comment #3
jhodgdonI can't commit this one, since I did the patch... assigning to webchick.
Comment #4
webchickWoohoo! Great to see this. :)
Committed and pushed to 8.x. Thanks!