silverstripe / silverstripe/developer-docs

Provide a security best practices cheatsheet

Open
#142 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Our doc provide a Security page with a dump of best practices. That page is not very readable.

It probably would help to review that page with an eye towards updating the list. We should also aim to separate advice about generic server set up and coding best practices.

We could also aim to structure the list of steps as a "Cheat Sheet" that people can easily reference.

Also relevant is the grahql security and best practices doc

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 reviewing the linked Security page and the GraphQL security and best practices page. Compare their advice, identify what belongs to generic server setup versus coding practices, and reorganize the material into a readable cheat sheet. Done means the guidance is clearly separated, structured for quick reference, and updated where needed.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql
Domain
documentation, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.