silverstripe / silverstripe/developer-docs

Include Available Version markers when documenting new features

Open
#500 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Pages affected
Description

Often documentation for new features lands in this repo (and is published) before the version it becomes available in is shipped. Even after it ships, some projects may not be updated immediately. This can create some confusion when a developer discovers and attempts to reference documentation for a feature that isn't yet available in their project.

To combat this, I propose introducing a guideline to encourage the inclusion of an 'Available from x.y' flag above any newly created documentation. In addition, I'd suggest we prune these flags when branching a new major version of the docs, since all flagged documentation can be assumed to be current at that point.

Validations
  • Check that there isn't already an issue that reports the same problem

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 with the two affected pages: Manipulating Eager Loading Queries and Validation constraints via Symfony Validator. Review how documentation is versioned and branched, then define where the “Available from x.y” guideline and markers belong. Done means the guideline is documented and the proposed markers and pruning approach are consistently addressed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.