-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC Update README.md for CMS 5 #124
DOC Update README.md for CMS 5 #124
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please, move the added section in About this module
section before Configuration
section, to be consistence with another module's README
That's not in scope for this issue - this issue is for updating readme content to be correct for CMS 5. The order of items in the readme is not relevant to that task. There are far too many modules and far too many possible permutations to worry about that in this issue. It could take ages to validate that everything is consistent. |
I think, since it's a new section we can append it in "correct" section. |
Neither "About this module" nor "Configuration" are new sections? Maybe I've misunderstood your request... can you please rephrase it to be more explicit? |
You have added new |
Ahhh, I see what you mean now. Though I don't think that's actually going to be more consistent than the current situation. All of the installation sections that I added were added as the first second-level heading. Which other module are you referring to that has the installation section as a third-level heading under some "about the module" heading? |
If you have a look at these modules you will see that |
Ahh okay. I don't think it really matters much but no worries I'll make it consistent with the way admin does it, i.e. installation will be a second-level heading underneath the "About this module" heading. This will also mean "Configuration" becomes a second-level heading. |
2c38799
to
1e41ed2
Compare
Done. Since I was in here editing this one manually I also added correct code syntax highlighting. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGFM
Issue