Problem/Motivation

Write module description and README.md

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

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:

Comments

anybody created an issue. See original summary.

anybody’s picture

And a screenshot from the setting in the product variation type, please :)

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

niharika.s’s picture

Status: Active » Needs review
lrwebks’s picture

Status: Needs review » Needs work

The proposed README is still missing a lot of points and not following the Drupal Standard very well.

It also seems to be a more or less direct Markdown translation of the module page, which is not what we wanted since we wanted to redo the module page too.

I will redo it quickly.

lrwebks’s picture

Status: Needs work » Needs review

Once this is merged, I can use the README as a template for the module page and improve it a bit (including our support snippets at the end of the page).

anybody’s picture

Assigned: lrwebks » grevil
grevil’s picture

Assigned: grevil » lrwebks
Status: Needs review » Needs work

Commented the MR.

grevil’s picture

And don't forget the README help page hook:

/**
 * Implements hook_help().
 */
function my_module_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.my_module':
      $text = file_get_contents(__DIR__ . '/README.md');
      if (!\Drupal::moduleHandler()->moduleExists('markdown')) {
        return '<pre>' . Html::escape($text) . '</pre>';
      }
      else {
        // Use the Markdown filter to render the README.
        $filter_manager = \Drupal::service('plugin.manager.filter');
        $settings = \Drupal::configFactory()->get('markdown.settings')->getRawData();
        $config = ['settings' => $settings];
        $filter = $filter_manager->createInstance('markdown', $config);
        return $filter->process($text, 'en');
      }
  }
  return NULL;
}
lrwebks’s picture

Status: Needs work » Needs review

I have added the help hook now and also rephrased the description and configuration sections to point out that the prefix label is generated, and the separator is configurable.

@grevil, what do you think — is the new phrasing appropriate?

anybody’s picture

Assigned: lrwebks » grevil
anybody’s picture

Assigned: grevil » Unassigned
Priority: Minor » Normal
Status: Needs review » Reviewed & tested by the community

Great! Merging!

anybody’s picture

Status: Reviewed & tested by the community » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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