Project Documentation

by Gisle Hannemyr

TBA

Introduction
Final word

Drupal extensions discussed in this chapter: Project Documentation.

Introduction

The D7 version of this module is a features export of the GUI created content type "Project documentation". See README.md for Fields created.

When updating, to get back to packaged View use: "Revert".

Main settings

Name:: Project documentation
Description: Content type to record project name, who installed it, when, why, and its install-status.

Do not promote to front page.
Do not create new revision.
Don't display post information.

Fields

Two pre-existing fields are appropriated and used:

Project name title
Why body – no summary

Four additional fields are created:

Shortname field_projdoc_shortname – plain text
Link to project at Drupal.org field_projdoc_projectpage – link, external only
Date first installed field_projdoc_dateinst – date, date only, default: current date.
Owner of project field_projdoc_who – user, don't include anonymous

Manage display

All labels inline.

Order of fields:

Why.
Link.
Shortname.
Who.
Date.
Status.

Permisions for Content editor:

Create new content.
Edit own content.

THe exported configuration consists of the following files:

node.type.projectdocumentation.yml

core.base_field_override.node.projectdocumentation.promote.yml
core.base_field_override.node.projectdocumentation.title.yml

core.entity_form_display.node.projectdocumentation.default.yml

core.entity_view_display.node.projectdocumentation.default.yml
core.entity_view_display.node.projectdocumentation.teaser.yml

field.field.node.projectdocumentation.body.yml
field.field.node.projectdocumentation.field_projdoc_dateinst.yml
field.field.node.projectdocumentation.field_projdoc_projectpage.yml
field.field.node.projectdocumentation.field_projdoc_shortname.yml
field.field.node.projectdocumentation.field_projdoc_who.yml

field.storage.node.field_projdoc_dateinst.yml
field.storage.node.field_projdoc_projectpage.yml
field.storage.node.field_projdoc_shortname.yml
field.storage.node.field_projdoc_who.yml

note All new fields (i.e. all except "body") also need to have a .yml-file for storage. Missing ones will prevent installation due to "unmet dependencies".

ToDo (D7)

Provide separator and charset for CSV (separate module: csv-config)?
Check if modules that comes with a project key actually exists on Drupal.org. (re: hnm_member).

Final word

Sample content:

https://www.drupal.org/project/devel
For debugging. Disable on a production site.

https://www.drupal.org/project/advanced_help
I always use this project.

https://www.drupal.org/project/mothermayi
To stop spambots from registering.

PVN customizations [No link to Drupal.org or shortname]
Customizations for PVN.

<ul>
<li>Fiddle Twilio field.</li>
<li>Hide remove button for attachments for non-admin.</li>
</ul>

Some legacy pages/extensions that provide information about a website:

Developer tool - technical sitemap (Groups post)
Site Documentation (D6 only).
System Information (D7 beta1)
X-ray (D7 beta2)
Varbase Total Control Dashboard
Total Control Admin Dashboard