silverstripe / silverstripe/developer-docs

Needs "How to Debug CMS errors" documentation

Open
#40 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

affects/v4 complexity/medium impact/medium type/docs
Dominant language
No language data
Stars
7
Forks
74
Avg merge
1d 14m
Merged PRs (30d)
6

Description

When I first started using Silverstripe and got any sort of saving/canView errors in the CMS in my own code, I had no idea that I could open the Google Chrome/Firefox developer tools and check the network tab to read the errors, and so I used to always try and quickly retrieve the error before it 'faded away'.

If we want to build a bigger community we need to think about the people that are just dipping their toes into web development too.

https://docs.silverstripe.org/en/3.3/developer_guides/debugging/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked Silverstripe debugging guide and the issue's examples of CMS saving and canView errors. Update the documentation to explain using Chrome or Firefox developer tools, especially the Network tab, to find these errors; done when a new user can follow the guide to retrieve a faded CMS error.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.