How I implemented the formatted 404 page for Sitecore Docker MVP Site

1/11/2022 08:39:00 PM

How I implemented the formatted 404 page for Sitecore Docker MVP Site

1. Fork the MVP repo:

My last year blog has details about how you can work with open source repos!

2. You are allowed to select your github account:

3. Since I already forked this repo, I'm taken to my forked repo page:

4. In the above page, you should be able to notice that this fork is one commit behind my upstream, which is nothing but the MVP repo. Fetch and merge the changes so that your forked repo will have the latest changes:

5. Once the merge is successful, the latest changes are in my fork:

6. Now, clone the forked repo locally:

Note that you must specify the forked repo and not the original repo in the above dialog!

7. Once you clone, you should be able to see the latest commit in your local repo:

10. Fill the .env file, up.ps1 and launch the Docker instance as per the github readme page or my earlier blogs:

https://navansitecorenotes.blogspot.com/2021/12/launching-mvp-102-site.html

https://navansitecorenotes.blogspot.com/2021/12/how-to-setup-sitecore-102-mvp-site.html

11. Next, access the existing not found page:

12. Then, setup the 404 content items as per my earlier blog (page loads in XPE for reference):

13. Now, it is time to switch over to Visual Studio 2019 and make some code changes to display this shiny new 404 page!

13.a Single line change to existing CustomContextItemResolver:

13.b Add the related setting to the config:

14. All done, time to Build Solution and while I compile, usually keep my docker logs open in PS window!

A 200 in the last line means all fine!

15. I check my 404 page in the web instance:

16. Check a valid page to be sure the 404 page works as per logic:

17. All good so far but the status code is still 200 and not 404 in the not found page!

18. To correct the 200 status code issue, add the following line in the pipeline processor,

19. Also, note that the old view returned from the default controller is no more needed:

20. Compile and check the page result, that does the trick:

21. Push the branch up, raise a PR and just relax since life is short ;)

Few more observations:

If you make a change to the Default Controller and save then you will see the usefulness of the logs since you can see an error in log due to the cs file save:

In the above case, stop mvp-rendering container as per my earlier blog, build the solution, start the mvp-rendering container and remember to run the Docker logs again!

Note that you will get the below 404 message if Docker container is still warming-up and hasn't returned 200 yet in the logs so, watching logs will give peace of mind!