Refactor Release doc

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start with 05_Contributing/05_Making_A_SilverStripe_Core_Release.md and review the discussion linked from pull request 9. Identify which existing sections remain relevant, then confirm with a CMS Squad member whether to relocate them or replace the article. Done means a reviewed, comprehensible high-level release overview is published, or the obsolete article is removed.

Written by the indexing model from the issue text.

Description

type/docs

Looking at the Making a SilverStripe core release, it's horribly out of date.

For the most part we are going off internal documentation that we haven't shared with the wider public.

The internal release doc would not make much sense as is without some guidance from a CMS Squad member.

I'm thinking either we scrap this entire doc article or we update it to be more generic so people have a general overview of what we do when we do a release.

Acceptance criteria

  • Doc is reviewed and bits that are still relevant are identified and move to a suitable place.
  • There's some generic doc explaining how we perform Silverstripe CMS. The doc provides a high level overview and is easy to comprehend.

Notes

Dominant language
No language data
Stars
7
Forks
74
Avg merge
1d 14m
Merged PRs (30d)
6

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.

More from silverstripe/developer-docs

All issues in silverstripe/developer-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.