Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

keep_archived_assets docs could be better

Abierto
  • ¿Algo no está bien?
#17 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
42/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
php
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Sin datos de lenguaje
Estrellas
7
Forks
76
Merge medio
22 h 58 min
PR fusionados (30 d)
1

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de silverstripe/developer-docs

Todos los issues de silverstripe/developer-docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.