Improve project description

Created on 1 May 2025, 4 months ago

Problem/Motivation

As someone new to CRM, it is unclear what exactly this project does / intends to do, how to get involved, etc.

Steps to reproduce

Proposed resolution

Improve the project's description (draft it below).

Proposed project description

πŸ“Œ Task
Status

Active

Version

1.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @jdleonard
  • πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA

    I'll take a stab at a first draft.

  • πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA

    Updated issue summary with a start.

  • πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA

    Added detail about CRM Core

  • πŸ‡ΊπŸ‡ΈUnited States mradcliffe USA

    We should avoid using a header at the top of the description to help with Project Browser initiative ( πŸ“Œ [Meta] Create a short description for a contrib module Active ). I would avoid using the Summary field because text_with_summary is proposed to be deprecated from core.

    Architecture section may be better suited to a CONTRIBUTING.md or DEVELOPERS.md file or gitlab pages.

    Create a short description (200 characters or less) that will be easily understood by the Project Browser target audience of site builders and those new to Drupal. The short description should answer the question - "what does this module do in a non-technical way".

    MAINTAINERS: the short description should be added to the Summary field of the Description on the project page. The short description will be displayed on the cards in the Project Browser grid and list views.

  • πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA

    @mradcliffe Thanks for reviewing.

    I'm inclined to leave the architecture piece where it is for the time being as it might be the first question some evaluating the project will have. It's also a key differentiator.

    I'm confused by "I would avoid using the Summary field" along with "the short description should be added to the Summary field of the Description on the project page", which seem to conflict.

    If we use the summary field for the short description, can we safely use headers in the rest of the description?

  • πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA
  • πŸ‡ΊπŸ‡ΈUnited States jdleonard Austin, TX, USA
  • πŸ‡ΊπŸ‡ΈUnited States bluegeek9
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024