From a446243c18df703266baca2f1e579d9431fb8b0c Mon Sep 17 00:00:00 2001 From: Sabrina Granger <sabrina.granger@inria.fr> Date: Thu, 6 Feb 2025 10:14:35 +0000 Subject: [PATCH] Upload FAQ in Spanish File --- FAQ-es.md | 598 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 598 insertions(+) create mode 100644 FAQ-es.md diff --git a/FAQ-es.md b/FAQ-es.md new file mode 100644 index 0000000..eb8b46b --- /dev/null +++ b/FAQ-es.md @@ -0,0 +1,598 @@ +<!--- + +This is commented because the FAQ page on SWH WordPress website is +dynamically generated from this markdown document and this should +not be displayed. + +After each document update in this git repository, the FAQ page is +automatically updated on the WordPress website. + +--- + +---> + +# FAQ + +Traducción realizada por : Jaime Arias, Miguel Colom Barco, José Armando Hernandez Gonzalez, Giacomo Lorenzetti + +## 1. General + +### 1.1 ¿Qué es Software Heritage? + +Software Heritage es una infraestructura abierta, sin ánimo de lucro, lanzada +en 2016 por Inria. Está apoyada por un amplio panel de instituciones e +industriales asociados, en colaboración con la UNESCO. + +<details> +<summary> Expandir para más detalles </summary> +<br> + +El objetivo is colectar todo el software disponible de forma pública en +forma de código fuente, junto con su historia de desarrollo, replicarlo +masivamente para asegurar su preservación y compartirlo con cualquiera que +lo necesite. + +Para más información sobre la +[misión](https://www.softwareheritage.org/mission/) de Software Heritage. +</details> + +### 1.2 ¿Qué es el archivo Software Heritage? + +El archivo Software Heritage es la colección pública más grande que existe +de código fuente. Visite el archivo en <https://archive.softwareheritage.org>. + +### 1.3 ¿Cuál es el tamaño del archivo? + +El archivo crece con el tiempo a medida que recopilamos nuevos códigos fuente +de proyectos de software y forjas de desarrollo. Puede ver contadores en tiempo +real del contenido del archivo, asà como un desglose por orÃgenes recopilados, +en <https://archive.softwareheritage.org>. + +### 1.4 ¿Cuáles son los servicios de Software Heritage? + +Software Heritage es una plataforma mutualizada que ofrece un número creciente +de servicios a un amplio espectro de usuarios. + +La página [features](https://www.softwareheritage.org/features/) ofrece una +visión general de las funcionalidades actualmente disponibles. Esto incluye, +por ejemplo, la posibilidad de archivar repositorios de software, navegar los +archivos de código fuente y generar identificación persistente. + +## 2. Archivado de software + +### 2.1 ¿Qué plataformas de software (forjas, gestores de paquetes, etc.) se archivan? + +Los orÃgenes de software que actualmente se archivan de forma regular están +listados en la [página principal del +archivo](https://archive.softwareheritage.org). + +<details> +<summary> Expandir para más detalles </summary> +<br> + +Aquà hay un extracto de esta lista: + +- Repositorios git de múltiples forjas (instancias GitHub, Bitbucket, GitLab, cgit, Gitea, Phabricator, etc.) +- Repositorios SVN ... +- Repositorios Mercurial ... +- Paquetes Debian en apt +- Paquetes Python en PyPi +- Paquetes R en CRAN +- Paquetes NPM en npm.org +- Ficheros zip o archivos tarball en gnu.org + +</details> + +### 2.2 ¿Si mi código está en GitHub/GitLab/Bitbucket, entonces ya está archivado en Software Heritage? + +PodrÃa ser el caso, ya que inspeccionamos estas y otras forjas populares +regularmente. Busque su repositorio de código en +<https://archive.softwareheritage.org/browse/search/>. + +<details> +<summary> Expandir para más detalles </summary> +<br> + +Si aún no está, o si la última copia instantánea (snapshot) no es el estado +más reciente de su repositorio, usted puede lanzar un nuevo archivo usando la +funcionalidad Save Code Now <https://archive.softwareheritage.org/save/> o +cliqueando en el botón "Save again" en el navegador. + +Un [GitHub +action](https://github.com/marketplace/actions/save-to-software-heritage) está +disponible para enviar automáticamente una petición Save Code Now. Aquà está un +[ejemplo](https://github.com/patrickfuchs/buildH/blob/master/.github/workflows/archive-to-software-heritage.yml) +de esta acción configurada para que se ejecute cada vez que se publique una +nueva versión. También puede usar la [extensión del +navegador](https://www.softwareheritage.org/2022/08/02/updateswh-browser-extension/). +</details> + +### 2.3 ¿Si elimino el repositorio que contiene mi código, ¿los datos permanecerán en Software Heritage? + +SÃ, todos los artefactos del código fuente del software se conservan a largo plazo. + +### 2.4 ¿Cuál es la polÃtica que determina lo que merece ser archivado? ¿Existen requisitos para que un repositorio de GitHub, GitLab o XXX sea archivado por Software Heritage? + +Nosotros no inspeccionamos ni filtramos el código fuente, y archivamos todos lo +que podamos encontrar. Por lo tanto, no hay requisitos, pero sugerimos seguir +las [guÃas de Software +Heritage](https://www.softwareheritage.org/howto-archive-and-reference-your-code/) +para mejores resultados. + +<details> +<summary> Expandir para más detalles </summary> +<br> + +La razón de este enfoque es porque el valor del código fuente no puede ser +conocido con antelación. Cuando se inicia un proyecto, no se puede predecir si +se convertirá o no en un componente clave del software. Por ejemplo, cuando +[Rasmus Lerdorf](https://fr.wikipedia.org/wiki/Rasmus_Lerdorf) lanzó la +[primera versión de PHP en +1995](https://groups.google.com/g/comp.infosystems.www.authoring.cgi/c/PyJ25gZ6z7A/m/M9FkTUVDfcwJ), +quién podrÃa haber predicho que se convertirÃa en una de las herramientas más +populares de la web. + +<figure> +<img src="https://imgs.xkcd.com/comics/dependency.png"> +<figcaption> + +XKCD Comics <https://xkcd.com/2347/> (CC BY-NC 2.5) +</figcaption> +</figure> + +También podrÃa ocurrir que [partes muy valiosas de código fuente pasen +desapercibidas durante muchos años](https://en.wikipedia.org/wiki/OpenSSL), +hasta que un dÃa un [fallo inesperado nos muestra que una parte muy +importante de nuestra infraestructura digital depende de +ellas](https://en.wikipedia.org/wiki/Heartbleed). + +</details> + +### 2.5 ¿Se verifica el código en busca del archivo LICENSE o alguna caracterÃstica especÃfica en el repositorio antes de archivarlo? + +Software Heritage archiva todo lo que está disponible públicamente, sin +pruebas ni comprobaciones preliminares. + +Esto significa que usted es responsable de comprobar si el código +fuente que se encuentra en el archivo se puede reutilizar y bajo qué +condiciones. + +Para el código que usted produce, le sugerimos que siga las mejores +prácticas estándar, que se encuentran en las [guÃas de Software +Heritage](https://www.softwareheritage.org/howto-archive-and-reference-your-code/), +incluyendo adicionar información sobre licencias. + +### 2.6 ¿También archivan software ejecutables (archivos binarios)? + +Nuestra misión principal es preservar código fuente, ya que es legible por +humanos y contiene información preciosa que queda descartada en los +ejecutables. En consecuencia no archivamos activamente ficheros binarios, +pero, si los binarios están incluidos en un repositorio de software, no +los filtramos en el proceso de archivado. Por lo tanto, es posible +encontrar algunos binarios en el archivo. + +### 2.7 No consigo encontrar todas mis “releases†en un repositorio git en Software Heritage, ¿qué deberÃa hacer? + +No se preocupe, su repositorio ha sido guardado enteramente. +Lo que está viendo es solamente una diferencia terminológica entre lo que plataformas como GitHub llaman “releases†(todas las etiquetas git sin anotaciones) y lo que nosotros llamamos “releases†(un nodo del árbol de Merkle, que corresponde a una etiqueta git anotada). Esto es un problema común, debatido por ejemplo en este [hilo](https://stackoverflow.com/questions/11514075/what-is-the-difference-between-an-annotated-and-unannotated-tag). + +<details> +<summary> Expandir para más detalles </summary> +<br> + +Por ejemplo, usted etiquetó su release llamándola "FinalSubmission", pero +sin usar una etiqueta anotada: en ese caso, no aparecerá en la pestaña +“Releases†en Software Heritage, pero, sin embargo, ¡está ahÃ! Haga clic en +el menú desplegable “branch†en la interfaz web de Software Heritage y la +encontrará listada como "refs/tags/FinalSubmission". Si usted quiere que su +release aparezca en nuestra interfaz web necesita crear sus etiquetas +utilizando "git tag -a" en vez de simplemente "git tag", o crear la release +directamente en la interfaz de la plataforma de alojamiento, que utiliza el +apropiado "git tag -a" detrás de escenas, y luego archiva otra vez el +repositorio. + +</details> + +## Referencia e Identificación + +### 3.1 <a name="SWHID"></a>¿Qué es un SWHID (SoftWare Hash Identifier)? + +El **SWHID** (SoftWare Hash Identifier) es un identificador intrÃnseco +persistente que se calcula de forma única a partir del propio artefacto de +software. Consulte [la publicación del blog dedicada para obtener más +información sobre los identificadores intrÃnsecos y extrÃnsecos]( https://www.softwareheritage.org/2020/07/09/intrinsic-vs-extrinsic-identifiers/). + +<details> +<summary> Expandir para más detalles </summary> +<br> + +Todos los detalles sobre la sintaxis, la semántica, la interoperabilidad y +la implementación se pueden encontrar en [la especificación +formal](https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html). + +El siguiente diagrama muestra de forma concisa los componentes clave de un +SWHID: + +<figure> +<img src="https://www.softwareheritage.org/wp-content/uploads/2020/06/software_ids-Copy-of-SWH-ID-3-1536x564.png"> +<figcaption> + +Crédito: Software Heritage, 2019 +</figcaption> +</figure> + +El cuadro amarillo superior del diagrama corresponde a la "*parte +principal del SWHID*" (core SWHID). Es posible añadir *qualifiers* +(calificadores) a un core SWHID para proporcionar información adicional +sobre la ubicación del objeto en el grafo de Software Heritage, o su +origen, y para identificar fragmentos de código. + +</details> + +### 3.2 <a name="whatSWHID"></a>¿Qué puede ser identificado con un SWHID? + +Primero, note que los software pueden ser identificados en diferentes +niveles de granularidad, que va del nivel conceptual (e.g. el nombre de un +proyecto de software) a artefactos concretos de software (e.g. un +directorio con muchos archivos). + +<figure> +<img src="https://hedgedoc.softwareheritage.org/uploads/upload_9d9303cc5952cf3d9e101aa8313ca276.png"> +<figcaption> + +Crédito: Research Data Alliance/FORCE11 Software Source Code Identification WG, 2020, <https://doi.org/10.15497/RDA00053> + +</figcaption> +</figure> + +Los SWHID están diseñados para identificar permanentemente e +intrÃnsecamente todos los niveles de granularidad correspondientes a los +artefactos concretos de software: snapshots, releases, commits, directorios, +archivos y fragmentos de código. + +<details> +<summary> Expandir para más detalles </summary> +<br> + +La parte principal del SWHID puede ser usado para identificar los +siguientes artefactos de código fuente: + +- **Contenido de un archivo**; por ejemplo, +[swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2](https://archive.softwareheritage.org/swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2) +apunta al contenido de un archivo que contiene el texto completo de la licencia +GPL3 + +- **directorios**; por ejemplo, +[swh:1:dir:d198bc9d7a6bcf6db04f476d29314f157507d505](https://archive.softwareheritage.org/swh:1:dir:d198bc9d7a6bcf6db04f476d29314f157507d505) +apunta a un directorio que contiene el código fuente de la aplicación de +fotografÃa Darktable tal y como estaba en algún momento de mayo 4 de 2017. + +- **revisiones** *(commits)*; por ejemplo, +[swh:1:rev:309cf2674ee7a0749978cf8265ab91a60aea0f7d](https://archive.softwareheritage.org/swh:1:rev:309cf2674ee7a0749978cf8265ab91a60aea0f7d) +apunta a un commit en la historia de desarrollo de Darktable, con fecha de 16 +de enero de 2017, el cual agregó la posibilidad de deshacer/rehacer para las +máscaras + +- **releases**; por ejemplo, +[swh:1:rel:22ece559cc7cc2364edc5e5593d63ae8bd229f9f](https://archive.softwareheritage.org/swh:1:rel:22ece559cc7cc2364edc5e5593d63ae8bd229f9f) +apunta a la versión 2.3.0 de Darktable, de fecha 24 diciembre 2016 + +- **snapshots**; por ejemplo, +[swh:1:snp:c7c108084bc0bf3d81436bf980b46e98bd338453](https://archive.softwareheritage.org/swh:1:snp:c7c108084bc0bf3d81436bf980b46e98bd338453) +apunta a una instantánea del repositorio git entero de Darktable tomada el 4 de +mayo de 2017 de GitHub + +Utilizando el calificador "*lines*", también es posible identificar +"*fragmentos de código*", i.e. lÃneas de código seleccionadas. + +Por ejemplo, +[swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2;lines=4-6](https://archive.softwareheritage.org/swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2;lines=4-6) +señala las lÃneas 4 a 6 del texto completo de la licencia GPL3. + +En términos más generales, el uso de un SWHID completamente cualificado +proporciona toda la información relevante para situar un artefacto de +software en su contexto. Por ejemplo, el siguiente SWHID señala el +algoritmo de mapeo central contenido en el archivo *parmap.ml*, ubicado en +el directorio *src* de una revisión especÃfica del proyecto Parmap +recuperado de *<https://github.com/rdicosmo/parmap>* + +[swh:1:cnt:3b997e8ef2e38d5b31fb353214a54686e72f0870;origin=https://github.com/rdicosmo/parmap;visit=swh:1:snp:25490d451af2414b2a08ece0df643dfdf2800084;anchor=swh:1:rev:db44dc9cf7a6af7b56d8ebda8c75be3375c89282;path=/src/parmap.ml;lines=192-237](https://archive.softwareheritage.org/swh:1:cnt:3b997e8ef2e38d5b31fb353214a54686e72f0870;origin=https://github.com/rdicosmo/parmap;visit=swh:1:snp:25490d451af2414b2a08ece0df643dfdf2800084;anchor=swh:1:rev:db44dc9cf7a6af7b56d8ebda8c75be3375c89282;path=/src/parmap.ml;lines=192-237) + +</details> + +### 3.3 ¿Cómo puedo obtener un SWHID para mi software? + +La parte principal del SWHID es intrÃnseco, asà que sÃ, ¡puede calcular la +parte principal del SWHID de cualquier artefacto de software localmente en +su máquina! ¡Encontrará las instrucciones en la [documentación disponible +aquÃ](https://docs.softwareheritage.org/devel/swh-model/cli.html)!. + +También puede obtener el SWHID completo de cualquier artefacto de software +archivado directamente desde el [archivo de Software +Heritage](https://archive.softwareheritage.org): usando la pestaña +vertical roja llamada "Permalinks", presente en todas las páginas que +muestran código fuente (consulte [este HOWTO para obtener más +detalles](https://www.softwareheritage.org/howto-archive-and-reference-your-code/)). +La ventaja de este segundo enfoque es que puede obtener un SWHID con +información contextual relevante (e.g. la posición de su artefacto en el +grafo global del desarrollo de software). + +<details> +<summary> Expandir para más detalles </summary> +<br> + +La pestaña "Permalinks" le permite obtener un SWHID para el contenido que +está navegando. He aquà un ejemplo: + + + +Haciendo clic en "Copy identifier" puede obtener el SWHID en su +portapapeles. Haciendo clic en "Copy permalink" puede obtener en su +portapapeles la URL correspondiente. + +La casilla "Add contextual information" le permite elegir si desea obtener +la parte principal del SWHID o el SWHID con los calificadores adicionales que +proporcionan información contextual. + +Observe que la pestaña Permalinks ofrece una multitud de opciones para +elegir un SWHID (puede obtener el del contenido del archivo, el del directorio +que lo contiene, el de la revisión, el de la release o el de la snapshot). Vea +la siguiente pregunta para comprender cuál es la mejor para su caso de uso. + + +</details> + +### 3.4 ¿Qué tipo de SWHID deberÃa utilizar en mi artÃculo/documentación? + +Realmente depende de su caso de uso, pero una sugerencia general que +recomendamos es tomar el *SWHID completo de un directorio (con la +información contextual)*. + +<details> +<summary> Expandir para más detalles </summary> +<br> + +Al escribir un artÃculo de investigación, una entrada de blog o una +documentación técnica, uno puedo encontrar cierta tensión entre la necesidad de +proveer la máxima cantidad de información, usando un SWHID completo, o mantener +una referencia corta (por ejemplo, por una limitación en el número de páginas). + +La mejor práctica recomendada para tratar este problema es la siguiente: + +1) obtener el SWHID completo para el ‘directory’ (directorio) que contiene +la versión del código que quiere referenciar. A continuación, un ejemplo de +SWHID completo: +`swh:1:dir:013573086777370b558b1a9ecb6d0dca9bb8ea18;origin=https://gitlab.com/lemta-rheosol/craft-virtual-dma;visit=swh:1:snp:ef1a939275f05b667e189afbeed5fd59cca51c9d;anchor=swh:1:rev:ad74f6a7f73c7906f9b36ee28dd006231f42552e` + +2) asegurarse de que la parte principal del SWHID +(`swh:1:dir:013573086777370b558b1a9ecb6d0dca9bb8ea18` en el ejemplo anterior) se +imprima, y que el SWHID completo esté disponible al menos como un hiperenlace. + +Este efecto se puede conseguir como sigue en LaTeX: + +```\href{https://archive.softwareheritage.org/swh:1:dir:013573086777370b558b1a9ecb6d0dca9bb8ea18;origin=https://gitlab.com/lemta-rheosol/craft-virtual-dma;visit=swh:1:snp:ef1a939275f05b667e189afbeed5fd59cca51c9d;anchor=swh:1:rev:ad74f6a7f73c7906f9b36ee28dd006231f42552e/}{swh:1:dir:013573086777370b558b1a9ecb6d0dca9bb8ea18}``` + +o en Markdown: + +```[swh:1:dir:013573086777370b558b1a9ecb6d0dca9bb8ea18](https://archive.softwareheritage.org/swh:1:dir:013573086777370b558b1a9ecb6d0dca9bb8ea18;origin=https://gitlab.com/lemta-rheosol/craft-virtual-dma;visit=swh:1:snp:ef1a939275f05b667e189afbeed5fd59cca51c9d;anchor=swh:1:rev:ad74f6a7f73c7906f9b36ee28dd006231f42552e/)``` + +Este enfoque permite que en cualquier versión *impresa* el lector va a +encontrar el *identificar que es más útil para reproducibilidad*: el SWHID +principal del directorio. Ciertamente, **el SWHID principal de un +directorio se puede calcular localmente desde cualquier instancia de un +código fuente**, independientemente de la release o del commit que lo +contiene en un proyecto especÃfico. + +En la versión digital, *el enlace clicable* usa *el SWHID completo* para +permitir al lector navegar por el código en Software Heritage con el +contexto adecuado (versión, origen, etc. etc.). + +</details> + +### 3.5 Quiero el SWHID completo de un código fuente que aún no está en el archivo. ¿Cómo puedo obtenerlo? ¿Cuánto tardará? + +Si su código (o la última versión del mismo) aún no está en el archivo, +primero debe iniciar su archivo. Esto puede hacerse con una solicitud +["Save Code Now"](https://save.softwareheritage.org), o a través de la API +de depósito. + +Una vez enviada una solicitud "Save Code Now", la incorporación del código +suele completarse en unos minutos, dependiendo del tamaño del repositorio. Una +vez completada, el estado de la solicitud de guardar se actualiza y puede +obtener el SWHID como se mostró anteriormente. + +Cuando se envÃa un depósito, la incorporación también suele completarse en +unos minutos y se puede acceder al SWHID a través de la respuesta de estado de +SWORD. + +## 4. Acceso y reutilización + +### 4.1¿Puedo reutilizar los artefactos de código fuente que encuentro en Software Heritage? + +Depende de la licencia del artefacto, tal como se almacena junto con el +código fuente: debe verificar esta licencia antes de descargarlo o +reutilizarlo. Si no puede encontrar la información de la licencia, debe asumir +que no tiene derecho a reutilizarlo. + +<details> +<summary> Expandir para más detalles </summary> +<br> + +Todos los componentes de software presentes en el Archivo pueden estar +protegidos por derechos de autor u otros derechos como patentes o marcas +comerciales. Software Heritage puede proporcionar información derivada +automáticamente sobre las licencias de software que pueden aplicarse a un +componente de software determinado, pero no hace ninguna afirmación con +exactitud y la información de licencia proporcionada no constituye +asesoramiento legal. Usted es el único responsable de determinar la +licencia, u otros derechos que se aplican a cualquier componente de +software en el Archivo, y debe cumplir sus términos. + +</details> + +### 4.2 ¿Puedo clonar un repositorio utilizando Software Heritage? + +Por favor, no clone un repositorio completo directamente desde Software +Heritage: es un archivo, no una forja. Intente primero clonar un repositorio +desde el lugar donde se desarrolla: será más rápido y como ventaja añadida ya +estará en el lugar adecuado para interactuar con sus desarrolladores. + +<details> +<summary> Expandir para más detalles </summary> +<br> + +Software Heritage almacena todos los artefactos de software en un enorme +[árbol de Merkle](https://en.wikipedia.org/wiki/Merkle_tree) compartido, de +modo que exportar (una versión especÃfica de) un repositorio archivado +implica recorrer el grafo para obtener todos los contenidos relevantes y +empaquetarlos para su consumo. Esta operación es mucho más cara que +descargar un archivo tar existente o clonar un repositorio desde una forja. + +Si realmente Software Heritage es su último recurso, y no puede encontrar +el código fuente de su interés en otra parte, le recomendamos que descargue +solamente la versión que le interese, utilizando la opción "*directory*" +del botón Download que encontrará al navegar por el archivo. + +Si es absolutamente necesario, puede utilizar la opción más costosa +"*revision*" del botón Download, que preparará para usted el equivalente de +un `git bare clone`, que podrá utilizar sin conexión. Esto puede requerir +bastante tiempo (horas, o incluso dÃas para repositorios enormes). + +</details> + +### 4.3 ¿Puedo recuperar un artefacto de código fuente mediante la API? + +SÃ, usted puede. Si tiene el SWHID a mano, puede usar el método apropiado +de la API para navegar a través de los puntos finales (endpoints) para +seguir el grafo de artefactos del proyecto. Consulte la documentación de la +API para ver [lista de puntos finales +completa](https://archive.softwareheritage.org/api/#endpoint-index). + +<details> +<summary> Expandir para más detalles </summary> +<br> + +- [/api/1/snapshot/](https://archive.softwareheritage.org/api/1/snapshot/doc/) permite +obtener las ramas y etiquetas de la instantánea, cada una con una clave + `target_url` que contiene la URL de la + +- [/api/1/release/](https://archive.softwareheritage.org/api/1/release/doc/) +o +[/api/1/revision/](https://archive.softwareheritage.org/api/1/revision/doc/) que +permite obtener los datos correspondientes a la revisión o la release. +Suponiendo que usted obtenga una revisión, la clave +`directory_url` contiene una URL que apunta a: + +- [/api/1/directory/](https://archive.softwareheritage.org/api/1/directory/doc/) que +lista las entradas del directorio raÃz, con los enlaces a otros directorios y +objetos de contenido + +- [/api/1/content/](https://archive.softwareheritage.org/api/1/content/doc/) +devuelve toda la información sobre el contenido de un fichero, incluyendo +un enlace hacia los datos no procesados. + +También puede comprobar un origen y seguir sus visitas: + +- [/api/1/origin/search/](https://archive.softwareheritage.org/api/1/origin/search/doc/) +permite buscar la URL exacta del repositorio del código + +- [/api/1/origin/visits/](https://archive.softwareheritage.org/api/1/origin/visits/doc/) permite +listar en cuántas ocasiones Software Heritage visitó el repositorio y obtener +una instantánea asociada con cada visita. Para cada visita, la instantánea +está disponible como una clave `snapshot_url` que contiene la URL que permite +obtener el objeto instantánea correspondiente. + +Si está interesado en descargar una parte grande del repositorio (un +directorio o un conjunto de revisiones), deberÃa utilizar el servicio de +descarga llamado *Vault*. *Vault* le permite obtenerlos como por lotes y +descargarlos como un archivo tarball. La lista de puntos finales de Vault +está disponible al final de la [lista de todos los puntos finales de la API](https://archive.softwareheritage.org/api/1/) +</details> + +## 5. Metadatos de software + +### 5.1 ¿Puedo añadir metadatos a mi software? + +Un usuario normal puede añadir archivos de metadatos en el repositorio los +cuales serán incorporados e indexados cuando se use un formato de archivo +especÃfico (codemeta.json, package.json, pom.xml, etc.). + +<details> +<summary> Expandir para más detalles </summary> +<br> + +Siga las [guÃa de Software +Heritage](https://www.softwareheritage.org/howto-archive-and-reference-your-code) +sobre cómo preparar su código para el archivo. + +Más información sobre los formatos que se indexan y una visión general del +flujo de trabajo de metadatos se encuentra en la entrada de blog sobre [minerÃa +de metadatos de software](https://www.softwareheritage.org/2019/05/28/mining-software-metadata-for-80-m-projects-and-even-more/) +</details> + +### 5.2¿Qué metadatos se conservan de un repositorio de código, al utilizar la función "save code now"? + +Se conservan todos los metadatos que contiene el propio repositorio de +código fuente. Esto incluirá el historial de desarrollo y las fechas y mensajes +de los commit. Por el momento, otros artefactos de metadatos que no forman +parte del repositorio (conocidos como metadatos extrÃnsecos) no se conservan +cuando se usa la función Save Code Now. + +### 5.3 ¿Qué metadatos se conservan con un artefacto de software depositado? + +Todos los metadatos que se envÃan a través del protocolo SWORD que +acompañan al artefacto de software. Para más información, visite la +[documentación del depósito](https://docs.softwareheritage.org/devel/swh-deposit/api/metadata.html). + +### 5.4 ¿Qué es el archivo codemeta.json, por qué deberÃa utilizarlo? + +Como desarrolladores de software, puede que queramos proporcionar una +descripción legible por computadores de nuestros proyectos, sin embargo, hay +demasiados esquemas de metadatos para describir software y es fácil +perderse. + +La [Iniciativa CodeMeta](https://codemeta.github.io) creó un vocabulario +común para tratar este problema, basado en (una pequeña extensión) de las +clases [SoftwareApplication](https://schema.org/SoftwareApplication) y [SoftwareSourceCode](https://schema.org/SoftwareSourceCode) +de la bien establecida iniciativa [schema.org](https://schema.org), y +provee herramientas para convertir desde y hacia otros esquemas de +metadatos. + +El archivo **codemeta.json** es una representación JSON-LD del vocabulario +CodeMeta que se puede generar y validar fácilmente usando la herramienta de +código abierto [codemeta +generator](https://codemeta.github.io/codemeta-generator/). Al añadir un +archivo codemeta.json a su proyecto, facilita compartir la información de +metadatos y reduce la carga de tener que volver a escribir mucha +información en los formularios de entrada de datos. + +<details> +<summary> Expandir para más detalles </summary> +<br> + +Por ejemplo, el repositorio nacional de acceso abierto francés HAL busca el +fichero codemeta.json cuando se deposita un proyecto archivado en Software +Heritage y rellena el formulario de depósito a partir de la información que +este contiene, ¡un verdadero ahorro de tiempo! + +Finalmente, [Software Heritage +indexa](https://www.softwareheritage.org/2019/05/28/mining-software-metadata-for-80-m-projects-and-even-more/) los +metadatos contenidos en los archivos codemeta.json y permite realizar búsquedas +en la aplicación web mediante la tabla de correspondencias CodeMeta. Esta tabla +de correspondencias es la piedra Rosetta de los metadatos de software, +facilitando asà la traducción entre diferentes ontologÃas y estándares de +metadatos para software. + +<figure> +<img src="https://hedgedoc.softwareheritage.org/uploads/upload_ef853cffeee220220c6e12a7ba0c40db.png"> +<figcaption> + +Crédito: Gruenpeter M. and Thornton K. (2018) Pathways for Discovery of Free Software (slide deck from LibrePlanet 2018). <https://en.wikipedia.org/wiki/File:Pathways-discovery-free.pdf> +</figcaption> +</figure> +</details> + +### 5.5 ¿Software Heritage comprueba los metadatos (e.g. para verificar si se ha declarado una licencia)? + +La respuesta corta es no. Software Heritage no realiza ningún filtrado a +priori de los repositorios que se archivan. -- GitLab