Use headings on the project page

Created on 15 December 2024, 7 days ago

Documentation location/URL

https://www.drupal.org/project/documentation

Problem/Motivation

It is difficult to scan the page to find the information I need.

Proposed resolution

Use headings, something like this

This is the main project for all Drupal documentation. To learn more about helping with documentation efforts, start with the Contribute to documentation section of the handbook.

You can report issues regarding documentation in the following places:

About the documentation "infrastructure" (software tools for creating, editing, maintaining, locating, and reading the documentation on Drupal.org)

Create an issue in the Documentation project issue queue and use the Docs infrastructure component.

About documentation procedures and policies

Create an issue in the Documentation project issue queue and use the Policies and Procedures component.

API (api.drupal.org)

Create an issue in the Drupal Core project issue queue and use the documentation component. The only exception is a few files, such as the Form API reference, which are actually here in the Documentation git repository.

User interface text within Drupal core itself

Create an issue in the Drupal Core project issue queue and use the user interface text component.

Contributed project

Create an issue in the issue queue for that project.

Spam

Use the report spam link shown for comments and nodes, or the Report as spammer link shown in user profiles.

For any other issue with the Drupal.org online Community Documentation

Create an issue in the Documentation project issue queue or, better yet, just edit the page.

Remaining tasks

Feature request
Status

Needs review

Component

Placement/Navigation/Structure

Created by

🇳🇿New Zealand quietone

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

Comments & Activities

  • Issue created by @quietone
  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    I find the project page as proposed more readable. The list made probably more sense when the list items were fewer , and they did not appear as a wall of text like now.

  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    I would just avoid adding "or the Report as spammer link shown in user profiles" because in most of the cases what needs to be reported is a post or a comment, for which the Report as spammer link does not help much. It just adds a link to the user account in a view; site moderators then need to check all the comments or posts created using that account to find what needs to be deleted as spam.

  • 🇳🇿New Zealand quietone

    Thanks, I'm glad you found it easier to read. As for that spam, I only added formatting, that part about spam is already on the page. If that needs to be changed, I trust you know better than me what it should be.

  • 🇮🇹Italy apaderno Brescia, 🇮🇹

    This is the markup I used in the new revision.

    This is the main project for all <a href="http://drupal.org/documentation">Drupal documentation</a>, except contributed projects. For contributed projects create an issue in the issue queue for that project.
    
    To learn more about helping with documentation efforts, start with the <a href="http://drupal.org/contribute/documentation">Contribute to documentation</a> section of the handbook.
    
    <p>You can report issues regarding documentation in the following places:</p>
    
    <h3>About the documentation "infrastructure" (software tools for creating, editing, maintaining, locating, and reading the documentation on Drupal.org)</h3>
    <p>Create an issue in the <a href="http://drupal.org/node/add/project-issue/documentation" rel="nofollow">Documentation project issue queue</a> and use the <strong>Docs infrastructure</strong> component.</p>
    
    <h3>About documentation procedures and policies</h3>
    <p>Create an issue in the <a href="http://drupal.org/node/add/project-issue/documentation" rel="nofollow">Documentation project issue queue</a> and use the <strong>Policies and Procedures</strong> component.</p>
    
    <h3>API (api.drupal.org)</h3>
    <p>Create an issue in the <a href="http://drupal.org/node/add/project-issue/drupal" rel="nofollow">Drupal Core project issue queue</a> and use the <strong>documentation</strong> component. The only exception is a few files, such as the Form API reference, which are actually here in the Documentation git repository.</p>
    
    <h3>User interface text within Drupal core itself</h3>
    <p>Create an issue in the <a href="http://drupal.org/node/add/project-issue/drupal" rel="nofollow">Drupal Core project issue queue</a> and use the <strong>user interface text</strong> component.</p>
    
    <h3>Contributed project</h3>
    <p>Create an issue in the issue queue for that project.</p>
    
    <h3>Spam</h3>
    <p>Use the <em>report spam</em> link shown for comments and nodes.</p>
    
    <h3>For any other issue with the Drupal.org online Community Documentation</h3>
    <p>Create an issue in the <a href="http://drupal.org/node/add/project-issue/documentation" rel="nofollow">Documentation project issue queue</a> or, better yet, just edit the page.</p>
    
  • 🇳🇿New Zealand quietone

    Thanks, I think that is an improvement. Others may have further ideas but I am OK with closing this issue.

  • 🇮🇹Italy apaderno Brescia, 🇮🇹
Production build 0.71.5 2024