Convert views, views_ui module hook_help() to topic(s)

Parent issue was committed, so we can un-postpone this now!

Adding views module to this issue.

Created a patch for views&views_ui.

Patch wasn't correctly created. Remade.

Thanks for the patches! I don't have time to review them today, sorry! I will look at them soon though, and your efforts are appreciated.

Patch applied via STM.The experimental Help Topics module was enabled (Added screenshot below).
Reviewed each topic that was created and modified in this patch. Reviewed the patch for spelling and grammar. The topics in the patch ending in .html.twig.
I uploaded screenshots with topics created.

I do see problems with this patch:

- We don't want topics called things like "Views module overview"/"Views UI module overview".
- Link provided in "Views overview" topic for "online documentation for the views module" doesn't take you to the actual documentation page, after clicking it just reload the page you're currently on ("Views module overview" topic). I added screen that shows that link.

Updated issue summary with better instructions/guidelines

Another iteration on guidelines.

We've migrated the help topic standards to https://www.drupal.org/docs/develop/documenting-your-project/help-topic-... so updating issue summary again.

I will make the next patch for this issue in the next few days.

I had less time than i thought I would.

We just found out that all topic Twig files currently need to go into core/modules/help_topics/help_topics (with their finalized module-based file names), for the time being until the Help Topics module is stable. Updating issue summary. Patch will need to be updated too.

Working on this at DrupalCon Amsterdam :)

@spitzialist,

Welcome and thanks to contributing. I would recommend not to assign the issue to yourself, because your comment already says that you are working on it.
Before leaving unassign it please.
You may also say that you are working with "XXX" mentoring you if it the case?
My 2 cents,

Enjoy!

I sadly had some issue with my infrastructure and need to come back later, so unassigne.

I am taking a look into this at Amsterdam 2019 contrib session

Rerolled the patch against 8.9.x, just adding the label and top_level tags in the new format. (based on the observation that drush cr failed due to these tags being in a format no longer supported)

Note: I did not revise the actual content of the Views+Views UI help topics (presuming these were already worked on by topic experts), only fixed what was not working in the previous version of the patch (5), so that the Views and Views UI documentation links would be visible on the Help topics dashboard page.

@jhodgdon, you pointed out in #14 that Twig templates are required to be under Help topics module, rather than the Views/Views UI modules. Is this still the case?

While working on rerolling the the patch (updating to new formatting), it seems to me that the help topics appear just fine on the Help topics dashboard, when the twig templates are under the views+views ui modules.

The patch in #21 worked for me.

Before applying the patch:

After applying the patch Views overview and Views UI overview show up at topics:

Yes, the help topics appear just fine if the topics are in the views module (or anywhere else). But for now, we do want the topics under help_topics. See #14.

Also, just to be clear: Please read the information in the Help Topic Standards page (see link in issue summary) about how to divide help up into topics. We don't want to have one topic that is an overview of a module. We want to have topics that tell you how to use Drupal. This patch is just two module overviews. That is not what we want.

Thanks!

As I said in my previous comment, the patches here are not at all what we are looking for -- see https://www.drupal.org/docs/develop/documenting-your-project/help-topic-... and the issue summary here.

I'm going to make a new patch.

Here's a new patch. I did not make an interdiff, because it was not based on the previous patches.

#26 I applied the patch its looking good.

In views_ui.edit topic coming website encountered error in my system , its showing -> Twig\Error\RuntimeError: An exception has been thrown during the rendering of a template ("Route "help.help_topic" does not exist."). in Twig\Template->displayWithErrorHandling() (line 8 of /var/www/html/drupal-8.9/core/modules/help_topics/help_topics/views_ui.edit.html.twig).
Im trying to fix this error.

views_ui.add_display: After step 4 i think so we need to explain about FORMAT, FIELDS, FILTER CRITERIA , SORT CRITERIA and how to use advanced field set. I saw all mentioned in views_ui.edit topic but i think so we need to mention clearly in views_ui.add_display topic.
I would like to work on this issue can you comment above mentioned things are required or not.
Thank you!

Regarding the Twig error, I am not getting that error. Make sure you do a git pull before applying this patch. I think maybe you are running on an old version of Drupal Core before we changed the route names. Either that or maybe you need to run a cache rebuild.

Regarding add display, I do not want to repeat the information that is in the Edit topic (which you haven't seen apparently, due to the Twig error), in the Add Display topic. I think I should have made this into a link to that topic though. I will make a new patch within an hour.

Here's a new patch that makes a link to the related topic. I'm also going to make a follow-up issue to add some more links in existing topics.

Whoops, I forgot a word in that last patch. It should read "Follow the steps in Editing an existing view display to edit..." (the word "to" was missing). Here's the updated patch.

#29 Thanks for the comment, regarding twig error i will check.
Add Display topic link to edit topic that was good, i accepted that again we no need to repeat content.

I think so maybe no need to mention routing we can do link this i attached screenshot.

I'm not sure what you are suggesting? The latest patch now says:

+{% set view_edit = render_var(url('help.help_topic', {'id': 'views_ui.edit'})) %}
...
  <li>{% trans %}Follow the steps in <a href="{{ view_edit }}">Editing an existing view display</a> to edit the other settings for the display.{% endtrans %}</li>

That will turn it into a link to the "Editing an existing view display" topic. ... Oh, I see what you are suggesting, just putting the topic ID in there for the URL.

  <li>{% trans %}Follow the steps in <a href="views_ui.edit">Editing an existing view display</a> to edit the other settings for the display.{% endtrans %}</li>

If we did it that way, we would be implicitly assuming that the URL of topics must end in the topic ID. That is currently how URLs for topics are made, but it could be changed in code and then this would not work. It is better to ask the system to make the correct URL.

Hi jhodgdon
Thanks for the comment i accepted this.We need some more links and explanation i am going to work on this issue can u suggest me.

I don't think this patch needs any work. What do you think it needs?

I am not thinking anything, just i am asking if it maybe require some work can u suggest me that's it.

As far as I am concerned, all it needs is a full and careful review/test (see issue summary for all the things to review/test). When it is satisfactory, someone needs to mark it "Reviewed and Tested by the Community".

The patch in #31 contains 4 new topics all related to the Views module.

1. views.overview.html.twig: Looks good. Excellent succinct overview of views.

- There is the tiniest of typos (a missing period after the abbreviated "etc" on line 17). This is a very minor nit.
- I think we should be encoding > as > on lines 21, 22, and 23. This should be fixed.

2. views_ui.add_display.html.twig: Verified steps. Looks good.

- Again, we should be encoding greater-than signs as > (one in line 13).

3. views_ui.create.html.twig:

- Encode greater-than sign as > (line 13).

4. views_ui.edit.html.twig: Excellent instructions that would apply to all views displays.

- Encode greater-than sign as > (line 13).

My apologies! I just realized that my IDE settings were rendering encoded greater-than signs in an effort to be helpful! (It turns out, this was not helpful.)

The patch in #31 looks fine. Setting this to RTBC.

Fixing the very minor typo you found in #40 -- added a . after etc in

+  <li>{% trans %}<em>Page settings</em>, <em>Block settings</em>, etc.: settings specific to the display type, such as the URL for a page display.{% endtrans %}</li>

by editing the patch. Since this one . is all I changed, leaving at RTBC.

Looks great, thank you @jhodgdon! +1 to keep this at RTBC.

#43 patch looking good.

Test failed with

Drupal\BuildTests\Framework\Tests\BuildTestTest::testPortMany
RuntimeException: Unable to start the web server.

I'll put this back to RTBC.

Same unable to start server message. Ugh.

Unrelated test fail.

This looks good to me, I tried it out locally and I think the content is a good primer on what is a complex piece of the Drupal UI.

This lead me to think about whether there is merit in giving the topics a relative complexity, such as 'Advanced / Basic / Moderate' so that people who're evaluating the topic can gauge whether it is a good fit for their skills.

In the user-guide we signal this with 'Prerequisite knowledge' so I think its probably something to discuss a bit wider if we need something similar with these topics, or if referring people to the user-guide is sufficient.

Committed 2651a49 and pushed to 9.1.x. Thanks!

The way I see it, the Help Topics should be the minimum necessary to be able to understand and manage a site, and cover the most common things people need to do. The User Guide has a lot more content... I am not sure about beginning/intermediate/advanced, but we could create an issue to do that and discuss further.