Bug 491179 - Add to N&N instructions that lowercase letters separated by hyphens should be used
Summary: Add to N&N instructions that lowercase letters separated by hyphens should be...
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Website (show other bugs)
Version: 4.4   Edit
Hardware: PC Linux
: P3 normal (vote)
Target Milestone: 4.7 M3   Edit
Assignee: Lars Vogel CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2016-04-06 13:30 EDT by Lars Vogel CLA
Modified: 2016-10-26 03:46 EDT (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Lars Vogel CLA 2016-04-06 13:30:27 EDT
We typically use ids like the following

<tr id="improved-performance-reduced-memory">

But this "rule" is not described, hence an entry like the following is also OK.

<tr id="SmartImport">

Markus, do you prefer the "lowercase separated by hyphens" style? If yes, we should add that to the rules.
Comment 1 Markus Keller CLA 2016-04-07 08:28:32 EDT
For images, the "all lowercase" style is really important, since this prevents bugs where references to the images work fine on case-insensitive file systems but fail in other environments.

Ids are always case-sensitive, so the problem is less severe there, and we didn't add a separate rule to avoid ending up with a huge list that nobody ever reads.

Nevertheless, no entry should deviate from the standard templates without a good reason. Every engineer should already know and follow that principle, but we can add it as an explicit statement if necessary.
Comment 2 Lars Vogel CLA 2016-04-07 08:32:18 EDT
(In reply to Markus Keller from comment #1)
> Nevertheless, no entry should deviate from the standard templates without a
> good reason. Every engineer should already know and follow that principle,
> but we can add it as an explicit statement if necessary.

I had several email discussion about it and wasted time on that. I add this as a rule.
Comment 3 Lars Vogel CLA 2016-10-26 03:45:04 EDT
Part of this was already fixed. Only instructions.html are not updated
Comment 4 Eclipse Genie CLA 2016-10-26 03:45:48 EDT
New Gerrit change created: https://git.eclipse.org/r/83909