magento/magento2#: Fix release notification README

[atwixfirster]

Description (*)

Provides fix for DevDocs magento/devdocs#5246

Fixed Issues (if relevant)

1. Markdown linting: No space after hash on atx style header (MD018 ) devdocs#5246: No space after hash on atx style header (MD018 )

Manual testing scenarios (*)

1. ...
2. ...

Questions or comments

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

CC: @jeff-matthews

Thank you!

[m2-assistant]

Hi @atwixfirster. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.3-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Guide documentation.

[magento-engcom-team]

Hi @VladimirZaets, thank you for the review.
ENGCOM-5799 has been created to process this Pull Request
✳️ @VladimirZaets, could you please add one of the following labels to the Pull Request?

Label	Description
Auto-Tests: Covered	All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered	Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required	Changes in Pull Request does not require coverage by auto-tests

[dshevtsov]

The issue with README was related to an extra space at the beginning of the header. There is no need to remove the entire header, only the extra space.
Change to:
# Magento_ReleaseNotification module

[atwixfirster]

The issue with README was related to an extra space at the beginning of the header. There is no need to remove the entire header, only the extra space.

done

Thanks, @dshevtsov

[jeff-matthews]

@dshevtsov, you're correct about the original issue, but I think there's some inconsistency across module READMEs. Some have the title, but some don't. It makes sense to remove this because we already include the module title in the metadata for the devdocs topic where we use this content. Having duplicate titles in devdocs is not ideal.

I suppose we can solve this in a separate issue since we already have inconsistency in devdocs.

[dshevtsov]

@jeff-matthews, there are several reasons to include the header:

1. Our template contains the header.
2. READMEs belong to the codebase at first place, so they should have a root header there.
3. devdocs site generator processes h1 headers as titles.
4. MRG topics are generated using custom tooling, so the automation can be customized to process READMEs differently depending on whether the h1 header is there.

[jeff-matthews]

We need to update the devdocs tooling then. I don't want to see duplicate H1s in the MRG on devdocs anymore.

[magento-engcom-team]

Hi @jeff-matthews, thank you for the review.
ENGCOM-5799 has been created to process this Pull Request
✳️ @jeff-matthews, could you please add one of the following labels to the Pull Request?

Label	Description
Auto-Tests: Covered	All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered	Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required	Changes in Pull Request does not require coverage by auto-tests

[m2-assistant]

Hi @atwixfirster, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.