development

My common checklist for Sitecore v8 Development

I notice that there is something which I should do in my Sitecore projects. That’s why I want to write it down as a common checklist for Sitecore development so that I can share it with everyone. Please give me a hand by dropping a comment if there is something wrong or missing. If this one is helpful, please broadcast it 😀 .

Security

  1. Ensure your custom admin page to inherit Sitecore.sitecore.admin.AdminPage then call the CheckSecurity method, learn more about it
    • sdc_8.png
  2. Ensure you include an Assert.CanRunApplication(“/path-to-application”) check in your custom application to enforce security, learn more about it
    • sdc_4.png
  3. Disable Edit and Preview Modes on CD servers, learn more about it
    • sdc_5.png
    • Note: you may need to set <setting name=”Preview.ResolveSite” value=”false” /> for using cross site links
  4. Set up a friendly static page for 404 and 401 HTTP status codes, learn more about it
    • sdc_6.png
  5. Set up a friendly static page for 500 HTTP status code, learn more about it
    • sdc_7.png
  6. Prevent unauthorized access to the Sitecore client interfaces, learn more about it
  7. Secure response headers
  8. Prevent XSS vulnerability

Caching

  1.  enable output caching on Sitecore’s renderings if possible
    • sdc_11.png
    • Note: when caching is enabled please setup the processor to clear the cache on publish in the configuration files for each website
      • sdc_12.png

User Experience

  1. Use Editor friendly names in Sitecore, learn more about it
  2. Add the custom icons and some missing icons of Sitecore such as ApplicationsV2, BusinessV2, FlagsV2, NetworkV2, PeopleV2, SoftwareV2 to “Change Icon” dialog, learn more about it

 

SEO

  1. For SEO best practice, we should uniform the URLs for public pages:
    • All URLs (excluding Querystring) should be in lowercase
      • sdc_3
    • All URLs should have an ending slash
      • resources with extensions doesn’t require end slash e.g .css, .js
      • sdc_2
    • All URLs should default to HTTPS
      • when a URL is accessed on HTTP, it’s auto redirect to HTTPS
      • sdc_1
    • All URLs should redirect to www when not specified
      • sdc_9.png
    • Note: you can download an example of RewriteRules.config
  2. in case /sitemap.xml is called directly (without language params) then serves X links (X = number of supported language). This way Google can follow the sitemap.xml links and discover the alternative languages
    • sdc_10.png
  3. Making noindex for Staging/UAT servers so that content is NOT crawled
    • sdc_20.png

Experience Editor

  1. Sitecore’s JS overwrites the global jQuery variable so that it causes JS issues if our jQuery loads in the heading, learn more about it
    • sdc_21
    • // some code
    • sdc_22
  2. In debug mode, we should abort tracing and profiling for Web APIs if any, otherwise Sitecore adds its own HTML content to every single response (for displaying Sitecore Profile and Sitecore Trace info) so that it will break the content structure if response content type is json
    • sdc_23.png

Sitecore utilities / tools

Play with Sitecore utilities / tools, learn more about it

 

Happy Sitecore Community!

Advertisements

2 thoughts on “My common checklist for Sitecore v8 Development

  1. Nice checklist

    I have worked with the exact rewrite rules in a solution. And it was the root to a lot time wasting with possible bug tracking and strange behaviors.

    When you upgrade Sitecore or install a module like WFFM. Then sometimes you need to add some more stuff to the negate attribute. The never-ending story.
    I think it is more appropriate to tweak the linkManager, even make a custom one with the ending slash since the linkManager don’t support that yet.

    If that is not enough, then you could implement canonical url meta data, to ensure you don’t get duplicate content and search engines knows exactly

    Liked by 1 person

    1. Thanks for dropping your comment. I suppose that I’ve got the same experience on Rewrite Rules with you 😀 (especially with the strange behaviors).

      Totally agree with you about custom LinkManager and canonical URLs, they’re good options.

      Like

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s