Userguide vs. user-guide

65 views
Skip to first unread message

Christopher Pitt

unread,
Dec 15, 2015, 3:29:46 PM12/15/15
to SilverStripe Core Development
Hey folks,

We're thinking of recommending a pattern for how CMS user-specific documentation should be named. Just wanted to take a quick poll to see who prefers "userguide/index.md" and "userguide.md" and who prefers "user-guide/index.md" and "user-guide.md"...

Simply replying "userguide" or "user-guide" is sufficient for this to be a poll of sorts.

Kind regards
Chris

Stevie Mayhew

unread,
Dec 15, 2015, 3:34:56 PM12/15/15
to SilverStripe Core Development
user-guide

Marcus Nyeholt

unread,
Dec 15, 2015, 3:35:39 PM12/15/15
to silverst...@googlegroups.com

userguide

--
You received this message because you are subscribed to the Google Groups "SilverStripe Core Development" group.
To unsubscribe from this group and stop receiving emails from it, send an email to silverstripe-d...@googlegroups.com.
To post to this group, send email to silverst...@googlegroups.com.
Visit this group at https://groups.google.com/group/silverstripe-dev.
For more options, visit https://groups.google.com/d/optout.

Naomi Guyer

unread,
Dec 15, 2015, 4:00:05 PM12/15/15
to silverst...@googlegroups.com
userguide

Damian Mooyman

unread,
Dec 15, 2015, 7:49:15 PM12/15/15
to SilverStripe Core Development
userguide

On Wednesday, 16 December 2015 09:29:46 UTC+13, Christopher Pitt wrote:

Martine bloem

unread,
Dec 16, 2015, 4:20:49 AM12/16/15
to silverst...@googlegroups.com
Userguide


--

Daniel Hensby

unread,
Dec 16, 2015, 6:13:39 AM12/16/15
to SilverStripe Core Development
If we already have "docs/" why not "userdocs/"

failing that "userguide/"

3dgoo

unread,
Dec 16, 2015, 5:49:18 PM12/16/15
to SilverStripe Core Development
user-guide

James Turner

unread,
Dec 17, 2015, 4:03:30 PM12/17/15
to SilverStripe Core Development
user-guide

Stevie Mayhew

unread,
Jan 10, 2016, 2:59:22 PM1/10/16
to SilverStripe Core Development
I thought I would mention that my main reason for preferring `user-guide` is that this matches the URLSegment generated in SilverStripe for the same input 'user guide'. Seems weird to me to break a convention that is used throughout the ecosystem in a documentation section.

Cam Findlay

unread,
Jan 10, 2016, 8:24:57 PM1/10/16
to SilverStripe Core Development
I don't think this is a biggie, end of last year we got quite a lot of work done to improve the userhelp site and mostly used "userguide". I think would could accept either version though. A lot of thought for a simple hyphen :)


On Wednesday, 16 December 2015 09:29:46 UTC+13, Christopher Pitt wrote:

Stevie Mayhew

unread,
Jan 10, 2016, 8:46:27 PM1/10/16
to SilverStripe Core Development
Definitely not a big deal :D I made a new years resolution to explain myself and am trying to get past the first 15 days at least.

Sam Minnée

unread,
Jan 10, 2016, 9:05:19 PM1/10/16
to SilverStripe Core Development
Well, that's an excellent resolution, in any case. :-)

--

James Pluck

unread,
Jan 10, 2016, 10:49:28 PM1/10/16
to silverst...@googlegroups.com
Agreed - intriguing resolution.  I could learn to embrace that one - but then again - I'm told that my loquaciousness can be legendary from time to time already.

"Too many words" is what my wife keeps telling me *grin*

Kind regards

James Pluck (BSc)

David Alexander

unread,
Jan 10, 2016, 10:56:46 PM1/10/16
to silverst...@googlegroups.com
Keep it simple..."userguide" would be my preference :)

Reply all
Reply to author
Forward
0 new messages