Skip to content
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

Merged

Conversation

Copy link
Contributor

@sabina-talipova sabina-talipova left a 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

@GuySartorelli
Copy link
Member Author

GuySartorelli commented Apr 20, 2023

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.

@sabina-talipova
Copy link
Contributor

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.

I think, since it's a new section we can append it in "correct" section.

@GuySartorelli
Copy link
Member Author

Neither "About this module" nor "Configuration" are new sections? Maybe I've misunderstood your request... can you please rephrase it to be more explicit?

@sabina-talipova
Copy link
Contributor

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 Installation section. Could you, please, move Installation into About this module section before Configuration.

@GuySartorelli
Copy link
Member Author

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?

@GuySartorelli
Copy link
Member Author

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.

@GuySartorelli GuySartorelli force-pushed the pulls/3.0/cms5-readme branch from 2c38799 to 1e41ed2 Compare April 21, 2023 00:18
@GuySartorelli
Copy link
Member Author

Done. Since I was in here editing this one manually I also added correct code syntax highlighting.

Copy link
Contributor

@sabina-talipova sabina-talipova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGFM

@sabina-talipova sabina-talipova merged commit b86eb8d into silverstripe:3.0 Apr 21, 2023
@sabina-talipova sabina-talipova deleted the pulls/3.0/cms5-readme branch April 21, 2023 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants