Problem/Motivation

Recently, Drupal.org got a new documentation system for contrib modules. The Conditional Fields module's documentation still uses the old system, because when I try to view the current Conditional Fields documentation, I see the warning message:

This documentation needs to be migrated into the new documentation system. If you are a project maintainer, create a new documentation guide for your project first and then migrate this documentation.

I would like to add new pages to the Conditional Fields documentation about the API in Drupal 8, but I'd like to do that in the new documentation system if possible, to avoid creating extra work for this module's maintainers in the future.

Proposed resolution

The Conditional Fields maintainers (or someone with sufficient privileges) will need to:

  1. Go to https://www.drupal.org/project/conditional_fields
  2. Click "Edit" at the top
  3. Scroll all the way down to the vertical tabs section, and find the "Project documentation" vertical tab.
  4. At the bottom, in the text "Create a new Drupal 7 or Drupal 8 guide", click "Drupal 7" (which should link to https://www.drupal.org/node/add/guide?og_group_ref_documentation=2785809... ). Fill out the "Create Documentation guide" form, and click "Save".
    Suggested data:
    • Title: Conditional Fields
    • Language: English
    • Summary: Conditional Fields allows you to manage sets of dependencies between fields.
    • Description: Conditional Fields 7.x-1.x allows you to manage sets of dependencies between fields. When a field is “dependent”, it will only be available for editing and displayed if the state of the “dependee” field matches the right condition. When editing a node (or any other entity type that supports fields, like users and categories), the dependent fields are dynamically modified with the States API. A simple use case would be defining a custom “Article teaser" field that is shown only if a "Has teaser" checkbox is checked, but much more complex options are available.<br />Module Page: https://www.drupal.org/project/conditional_fields
    • Status: - None -
    • Leave all the other fields at their default values.
    • Click "Save"
    • Take note of the NID for this new documentation guide: you'll need it for setting a number of node reference fields below.
  5. Go to https://www.drupal.org/project/conditional_fields
  6. Click "Edit" at the top
  7. Scroll all the way down to the vertical tabs section, and find the "Project documentation" vertical tab.
  8. At the bottom, in the text "Create a new Drupal 7 or Drupal 8 guide", click "Drupal 8" (which should link to https://www.drupal.org/node/add/guide?og_group_ref_documentation=2785817... ). Fill out the "Create Documentation guide" form, and click "Save".
    Suggested data:
    • Title: Conditional Fields
    • Language: English
    • Summary: Conditional Fields allows you to manage sets of dependencies between fields.
    • Description: Conditional Fields 8.x-1.x allows you to manage sets of dependencies between fields. When a field is “dependent”, it will only be available for editing and displayed if the state of the “dependee” field matches the right condition. When editing a node (or any other entity type that supports fields, like users and categories), the dependent fields are dynamically modified with the States API. A simple use case would be defining a custom “Article teaser" field that is shown only if a "Has teaser" checkbox is checked, but much more complex options are available.<br />Module Page: https://www.drupal.org/project/conditional_fields
    • Related content: (link to the Drupal 7 documentation guide)
    • Status: - None -
    • Leave all the other fields at their default values.
    • Click "Save"
    • Take note of the NID for this new documentation guide: you'll need it for setting a number of node reference fields below.
  9. Edit the Drupal 7 documentation guide again, and set the Related content field to the Drupal 8 documentation guide page.
  10. Go to the existing Conditional Fields documentation page at https://www.drupal.org/node/1704126
  11. In the "This documentation needs to be migrated" warning, click "migrate this documentation", which should take you to https://www.drupal.org/migrate/documentation/1704126
  12. Select the Drupal 7 documentation guide you created earlier from the select box, click "Continue", and proceed with the migration process (I've never done this before so I'm not sure what happens next).
  13. Go to https://www.drupal.org/project/conditional_fields
  14. Click "Edit" at the top
  15. In the "Description" field, find the "Installation and Usage" section, and modify the text on the project page to link to both new documentation pages.
  16. Scroll all the way down to the vertical tabs section.
  17. In the "Issues" vertical tab, find the "Submission guidelines" field, and modify the text on the issue submissions guidelines to link to both new documentation guides.
  18. In the "Resources" vertical tab, empty the "Documentation" field.
  19. In the "Project documentation" vertical tab:
    1. Set:
      • Documentation guide: (link to the Drupal 7 documentation guide)
      • Applicable from: 7.x-1.x
    2. Click "Add another item"
    3. Set:
      • Documentation guide: (link to the Drupal 8 documentation guide)
      • Applicable from: 8.x-1.x
  20. Click "Save" to finish editing the project page.

Note: I have sufficient privileges on Drupal.org to do all of this for you if you'd like.

Remaining tasks

  1. Create D7 documentation guide (steps 1–4 above).
  2. Create D8 documentation guide (steps 5–8 above).
  3. Set D8 documentation guide to be related to D7 documentation guide (step 8 above).
  4. Set D7 documentation guide to be related to D8 documentation guide (step 9 above).
  5. Migrate the old documentation into the D7 documentation guide (steps 11–12 above).
  6. Modify the Conditional Fields project page description to link to the new documentation guide (step 15 above).
  7. Modify the Conditional Fields issue submission guidelines to link to the new documentation guide (step 17 above).
  8. Modify the Conditional Fields project page resources to remove link to the old documentation (step 18 above).
  9. Modify the Conditional Fields project documentation links to link to the new guides (step 19 above).
  10. Mark this issue as fixed.

User interface changes

N/A.

API changes

N/A.

Data model changes

N/A.

Comments

mparker17 created an issue. See original summary.

mparker17’s picture

Issue summary: View changes
mparker17’s picture

Status: Active » Reviewed & tested by the community

Need the project maintainers to review this issue.

Since there is no code, only the project maintainers can proceed on this issue, and testing is not possible, I'm going to be bold and mark this as RTBC.

mparker17’s picture

Issue summary: View changes
Status: Reviewed & tested by the community » Fixed

As instructed by @OlgaRabodzei, I have fixed this!

Please see the new Drupal 7 documentation here: https://www.drupal.org/node/2891959

... and the new Drupal 8 documentation here: https://www.drupal.org/node/2891960

mparker17’s picture

(attempting to set credit for the issue — EDIT: apparently did nothing)

Status: Fixed » Closed (fixed)

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