Remove unnecessary files and update README.md in devportal module #74
Conversation
adam-balogh
changed the title
README.md
Outdated
| conceptual documentation on your Drupal site. | ||
|
|
||
| * For a full description of the module, visit the project page: | ||
| https://www.drupal.org/project/devportal | ||
|
|
||
There was a problem hiding this comment.
This change is unneeded (and lines ending with whitespace are usually treated bogus).
README.md
Outdated
|
|
||
| * You can add the 'FAQ' custom module to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. | ||
|
|
||
| * If you are a content editor, we recommend you to enable the 'Guides' module, which describes the custom functionalities and collects the links for the related core drupal functionalities. |
There was a problem hiding this comment.
Firstly, content editors usually can't enable modules at all.
Secondly, it's better to write docs in passive (in order to avoid any personalization).
Thirdly, there are a bit too much functionalities in this sentence. ;)
README.md
Outdated
|
|
||
| INTRODUCTION | ||
| ------------ | ||
| # INTRODUCTION |
There was a problem hiding this comment.
This should be H2 aka ##. This is also true for other section titles below.
README.md
Outdated
| @@ -21,15 +18,39 @@ conceptual documentation on your Drupal site. | |||
| * To submit bug reports and feature suggestions, or to track changes: | |||
| https://www.drupal.org/project/issues/devportal | |||
|
|
|||
| * The customization capabilities of the Devportal module can be expanded by the 'Page builder' module. With it, the user can create highly customizable pages with reusable building blocks. | |||
There was a problem hiding this comment.
Page builder is not part of the devportal module.
README.md
Outdated
| @@ -21,15 +18,39 @@ conceptual documentation on your Drupal site. | |||
| * To submit bug reports and feature suggestions, or to track changes: | |||
| https://www.drupal.org/project/issues/devportal | |||
|
|
|||
| * The customization capabilities of the Devportal module can be expanded by the 'Page builder' module. With it, the user can create highly customizable pages with reusable building blocks. | |||
|
|
|||
| * You can add the 'FAQ' custom module to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. | |||
There was a problem hiding this comment.
Mentioning submodules as "custom module" is not a correct way, because in Drupal custom and contrib modules have different meaning. Please use "submodule" in this terminology.
README.md
Outdated
|
|
||
| * You can add the 'FAQ' custom module to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. | ||
|
|
||
| * We recommend you to enable the 'Guides' module, which describes the custom functionalities and collects the links for the related core Drupal capabilities. It is a useful tool for content editors. |
There was a problem hiding this comment.
This module doesn't provide any documentation by default, it just gives the ability for writers to upload docs. You can refer to the README.md file in this submodule: https://github.com/Pronovix/devportal-drupal-module/blob/8.x-2.x/modules/guides/README.md
unnecessary lines have been deleted, reference is added, terms have been fixed
README.md
Outdated
| * You can add the 'FAQ' submodule to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. | ||
|
|
||
| * We recommend you to enable the 'Guides' module, which gives the ability for writers to upload docs in Markdown. It is a useful tool for content editors. Read more here: | ||
| https://github.com/Pronovix/devportal-drupal-module/blob/8.x-2.x/modules/guides/README.md |
There was a problem hiding this comment.
You can use here as link title. Also, can you try adding this URL as a relative one? I'm not sure that it's even possible in GitHub, but it would be great to leave the branch name out from the URL.
README.md
Outdated
| @@ -21,15 +18,38 @@ conceptual documentation on your Drupal site. | |||
| * To submit bug reports and feature suggestions, or to track changes: | |||
| https://www.drupal.org/project/issues/devportal | |||
|
|
|||
| * You can add the 'FAQ' submodule to your Devportal. Questions can be grouped by topics and these topics can be used as filters on the FAQ listing page. | |||
|
|
|||
| * We recommend you to enable the 'Guides' module, which gives the ability for writers to upload docs in Markdown. It is a useful tool for content editors. Read more here: | |||
There was a problem hiding this comment.
Please use submodule instead of module here as well for consistency.
|
@adam-balogh Please rebase this PR. #73 has just been merged. |
Two unnecessary files were removed:
.gitignore
DevportalAdminEventSubscriber.php
'Readme.md' file has been updated [introduction, requirements].