Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

keep_archived_assets docs could be better

未关闭
#17 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
42/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
php
领域
documentation

调研方向

Compare the linked sections in File_Management.md, File_Security.md, and File_Storage.md with AssetControlExtension.php at the referenced configuration entry point. Determine which keep_archived_assets settings are active, then consolidate the guidance so the documented configuration is accurate and has one clear source of truth.

由索引模型根据 Issue 内容生成。

描述

affects/v4 complexity/medium type/docs

There are multiple separate references to configuring file archiving via keep_archived_assets

I'm not sure how many of these you actually need to set to true in order to get keep_archived_assets to function correctly. Possibly some of these are previous implementations and no longer do anything. Seems like we should at have a single source of truth in the docs for how to enable this feature.

Undocumented:

https://github.com/silverstripe/silverstripe-assets/blob/1/src/AssetControlExtension.php#L47

    private static $keep_archived_assets = false;

Documented:

https://github.com/silverstripe/silverstripe-framework/blob/4/docs/en/02_Developer_Guides/14_Files/01_File_Management.md#configuring-file-archiving

SilverStripe\Assets\File:
  keep_archived_assets: true

https://github.com/silverstripe/silverstripe-framework/blob/4/docs/en/02_Developer_Guides/14_Files/03_File_Security.md#configuring-archive-behaviour

class MyVersiondObject extends DataObject 
{
    /** Ensure assets are archived along with the DataObject */
    private static $keep_archived_assets = true;

https://github.com/silverstripe/silverstripe-framework/blob/4/docs/en/02_Developer_Guides/14_Files/04_File_Storage.md#versioned-and-archived-files-archived

SilverStripe\Assets\Flysystem\FlysystemAssetStore:
  keep_archived_assets: true
主要语言
没有语言数据
星标
7
派生
76
平均合并
1 天 12 小时
30 天内合并 PR
4

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

silverstripe/developer-docs 的其他 Issue

查看 silverstripe/developer-docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。