Edit hook_help text for Content Moderation module

Hi,

I have added patch for links.

+++ b/core/modules/content_moderation/content_moderation.module
@@ -35,11 +35,11 @@ function content_moderation_help($route_name, RouteMatchInterface $route_match)
+      $output .= '<dd>' . t('Each state is exposed as a <a href=":permission">permissions</a>. If a user has the permission for a transition, then they can move that node from the start state to the end state', array(':permissions' => \Drupal::url('user.admin_permissions'))) . '</p>';

:permission vs :permissions.

Otherwise, looks good and reads fine.

Updated the patch. Looks good now.

Patch fails to apply, so needs rerolling.

I tried to reroll #5 with https://www.drupal.org/patch/reroll.

Indicate whether it was an auto merge, if there were conflicts or if the file sizes were very different. If there were conflicts, describe what you did to resolve them. This will make it easier for the person reviewing the patch to know how carefully they need to review.

I had a conflict,

<<<<<<< 2d4af397bc894e59e84178a74b0ef3b02e632a3e
      $output .= '<dt>' . t('Configuring workflows') . '</dt>';
      $output .= '<dd>' . t('Enable the Workflow UI module to create, edit and delete content moderation workflows.') . '</p>';
      $output .= '<dt>' . t('Configure Content Moderation permissions') . '</dt>';
      $output .= '<dd>' . t('Each transition is exposed as a permission. If a user has the permission for a transition, then they can move that node from the start state to the end state') . '</p>';
=======
      $output .= '<dt>' . t('Moderation states') . '</dt>';
      $output .= '<dd>' . t('Moderation <a href =":states">states</a> provide the <em>Draft</em> and <em>Archived</em> states as additions to the basic <em>Published</em> option. You can click the blue <em>Add Moderation state</em> button and create new states.', array(':states' => \Drupal::url('entity.moderation_state.collection'))) . '</dd>';
      $output .= '<dt>' . t('Moderation state transitions') . '</dt>';
      $output .= '<dd>' . t('Using the <a href=":transitions">"Moderation state transitions"</a> screen, you can create the actual workflow. You decide the direction in which content moves from state to state, and which user roles are allowed to make that move.', array(':transitions' => \Drupal::url('entity.moderation_state_transition.collection'))) . '</dd>';
      $output .= '<dt>' . t('Configure Content Moderation permissions') . '</dt>';
      $output .= '<dd>' . t('Each state is exposed as a <a href=":permissions">permissions</a>. If a user has the permission for a transition, then they can move that node from the start state to the end state', array(':permissions' => \Drupal::url('user.admin_permissions'))) . '</p>';
>>>>>>> Applying patch from issue 2830832 comment #5

I removed the "first" part and kept the "second" one, I hope it was the right thing to do. It's my first contribution, so if I did something wrong tell me what please :)

@Keenegan - I think we needed to keep a mixture of the "first" and "second" sections. The failing tests are because the help text is now missing some expected components.

Rerolled the patch.

Re-rolling again

The original help page was changed greatly in another commit (Add a workflow component, ui module, and implement it in content moderation) since this issue was opened. This is why the patches are failing. Because of the extensive nature of those changes, It appears that the changes in this issue may no longer be applicable. However, there are two places where <dd> elements are closed with </p> tags in the new file as well. I have corrected these tags and created a new patch reflecting only this change.

This patch got a bit simpler! Even more straightforward.

All seems to make sense, especially in light of some of the other changes being made as mentioned by @rocketeerbkw.

Thanks.

Apologies, I thought that this ticket was heading towards the simpler end of the scale, rather than just reproducing what had already been done in #13.

I added back in a link to the permissions page in the uses section, but it seems strange to do so since it is listed as an administration page immediately after. Additionally, the state of the module seems to be a bit in flux. Perhaps it is settling down now. The link to the documentation is live, but the documentation does not reflect the current design of the module.

Ones you worked the issue and uploaded patch, please change the status to 'Needs review';

The patch of #21 applies well and I guess the status can be changed to RTBC.

@prash_98, keep in mind again that the automated testing infrastructure tells us whether the patch applies, so we do not need people to review that. What we do need people to review is whether the issue has a correct scope, whether it passes the core gates, whether the solution completely fixes the problem without introducing other problems, and whether it's the best solution we can come up with. See the patch review guide for more information. Thanks for your contributions!

Thanks @ifrik, agreed. For contributors on this issue, the best way to decide what to put in the help text is to test the module and see what it does, considering what features should be explained, if there are any gotchas, etc.

@xjm will surely keep in mind for the other issues.

@xjm,

The module is failing to get installed. The site crashes on enabling the module.

@prash_98 - Can you open a new issue with the issues you are getting when enabling the module?

@timmillwood -Yes would open one.

Working on this @Baltimore2017.

I applied the patch #21 and it fixed the Uses description tags, and I noticed the links to workflow was missing. I just added the link to workflow.

Please follow the coding standard.

Please read https://www.drupal.org/docs/develop/standards/coding-standards#indenting

Corrected the coding standards errors.

@ifrik, can you point to where this was done?