From https://www.drupal.org/node/2785809/discuss:

TR commented 20 October 2017 at 13:28

So I migrated my module's documentation to the new system, following the instructions, and yet my new documentation guide does not show up here - I still see "This guide has not yet been reviewed by Contributed modules maintainer(s) and added to the menu."

There's no step in the instructions that says I have to request this to be "reviewed", and no issue queue that I know of where I can post an issue requesting "review", so why has my module documentation not been reviewed and published yet?

  • There is still no procedure to get contributed module documentation guides published.
  • There is still no issue queue to handle requests for publication.
  • There's still no-one to contact when there are problems.
  • Guide maintainers are still not notified of new content.

I have about ~100 pages of documentation that I've written that have been posted since June 2018, but still do not show up under the "Contributed modules" documentation guide. What do I have to do to get this "added to the menu"?

This has to be fixed! If you want people to write documentation for D8, then let them publish it! And document the procedure needed, and make an issue queue for the publishing workflow and related problems.

CommentFileSizeAuthor
#11 automatic-approval.png54.07 KBhestenet

Issue fork drupalorg-3035738

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

TR created an issue. See original summary.

TR’s picture

TR CreditAttribution: TR commented
Issue summary: View changes

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

afagioli’s picture

afagioli
Location Rome
CreditAttribution: afagioli as a volunteer commented

Facing your same issue, I would suggest to read the Documentation FAQ https://www.drupal.org/node/266622 and eventually create an issue at
https://www.drupal.org/node/add/project-issue/documentation

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

hestenet’s picture

hestenet
He/Him
Location Portland, OR 🇺🇸
CreditAttribution: hestenet at Drupal Association commented
Project: Drupal core » Drupal.org customizations
Version: 9.4.x-dev » 7.x-3.x-dev
Component: documentation » Documentation
FileSize
automatic-approval.png54.07 KB

There is an option to configure Documentation Guides to have automatic approval, and the parent Contrib Documentation guide has that option selected, but it's clearly not working. We're going to look into it for a fix.

Automatic Approval Setting

ressa’s picture

ressa CreditAttribution: ressa at Ardea commented

Thanks @hestenet, it would be great to get this fixed. I created a guide Feb. 2022, and still waiting for it to get reviewed and added to the menu: https://www.drupal.org/docs/comparison-of-contributed-modules/comparison...

drumm’s picture

drumm
he/him
Location NY, US
CreditAttribution: drumm at Drupal Association commented

This is the code which should be making that work: https://git.drupalcode.org/project/drupalorg/-/blob/64f93b213fb90c4a6e94...

B_man made their first commit to this issue’s fork.

B_man opened merge request !102

  • B_man committed 2a16e98 on 7.x-3.x 
    Issue #3035738 by B_man, hestenet, TR, drumm: Adding a documentation...
B_man’s picture

B_man
he/him
Location California, USA
CreditAttribution: B_man at Drupal Association commented
Assigned: Unassigned » B_man
Status: Active » Fixed

This fix has been merged and deployed.

ressa’s picture

ressa CreditAttribution: ressa at Ardea commented

I commented about this the other day on the Content guidelines > Discuss Documentation page:

I was trying to add a new guide for a contrib module, following the instructions from Documentation > Adding new documentation.

So I clicked "Add guide" to create the main page for the contrib module, and after that add Pages under that Guide. But I got blocked when I tried to save the Guide page (the Menu settings > Parent item was empty) and got this error message:

"The menu you chose does not belong to the selected groups."

So I tried removing the check-mark from "Provide a menu link", and I could create the page.

I think this is blocking a lot of documentation from getting created, since people just give up. I know I have, before I really tried to make it work today ... so I propose one of these two options:

  • The check-mark is removed by default
  • -- OR --
  • Users are granted permission to create a menu link

Also, I think this excellent Documentation help page should be linked to from all the documentation pages, such as https://www.drupal.org/docs/contributed-modules, to help users easily get assistance.

After this update here I now see "Contributed modules" under Parent on the Edit page if I click "Create Guide" on the Contributed modules, so it seems like ordinary users can now create a new guide, as well as add a Parent item for the menu, so thanks for that.

Already created guides awaiting approval, such as https://www.drupal.org/docs/contributed-modules/boost are still in the queue for approval, and the Parent item is empty, if I open the Edit form.

drumm’s picture

drumm
he/him
Location NY, US
CreditAttribution: drumm at Drupal Association commented

The 171 guides that were not listed have been added. Query to find those was SELECT om.etid FROM og_membership om LEFT JOIN menu_links ml ON ml.link_path = concat('node/', om.etid) AND menu_name = 'menu-og-2785817' WHERE om.field_name = 'og_group_ref_documentation' AND om.gid = 2785817 AND ml.link_path IS NULL;

ressa’s picture

ressa CreditAttribution: ressa at Ardea commented

Thanks for publishing the guides @drumm.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

ressa’s picture

ressa CreditAttribution: ressa at Ardea commented
Related issues: +#3314318: Add some more documentation pages to their guide’s menu?

It turns out we have the same problem with "Contributed themes" documentation, where guides can stay un-reviewed and unpublished for a long time. See for example https://www.drupal.org/docs/contributed-themes/bootstrap5-theme which should be straight forward to publish.

I have created #3314318: Add some more documentation pages to their guide’s menu?.