Best Practices
To keep every Umbraco project instance tidy, it is crucial to follow the best practice rules. The rules are documented below and everyone working on Umbraco should follow them. Country project Publishers (a list of Publishers can be found on Confluence) are responsible for making sure that the rules are being obeyed.
Page Name
The Umbraco page name should be:
- In Sentence case format. Just like in standard sentence the first word is capitalized and the rest of the words are lowercase.
- Every word should be split by a space.
- Don't have any special characters - !, #, $, &, etc., including any special alphabet characters - á, ö, æ, ù, etc.
- Can be in a localized language but should follow the rules 1-3.
Correct Umbraco page names:
- Bingo games
- Bingo community
- About tombola bingo
- Payment methods
Incorrect page names:
- bingo games
- BINGO COMMUNITY
- about-tombola-bingo
- $$$ Payment methods $$$
In rare cases these rules might be overruled, for example when page name includes a promotion or company name - Deal or No Deal, BBB, etc.
Media Files
Any media uploaded to Umbraco should be:
- Placed in an appropriate folder as explained on Media page.
- Have a descriptive name in an English language and have something that makes it unique, like a size in pixels in the name. For example:
- bingo90-game-banner-800x500.png
- teal-background-with-golden-confetti-3840x2160.jpg
- download-on-google-play-black-icon-300x100.jpeg
Media Folder Structure
The media folder structure needs to be followed but if a new folder needs to be created:
- Onboarding team is aware that the new folder is created.
- Folder name should be in plain English language.
- Folder name should be in Title Case format where every word is capitalized. For example:
- Payments
- Mobile App
- Social Media