Actualizada seccion de participacion y otros cambios menores.
This commit is contained in:
parent
9aaae8940d
commit
2e8957c12e
43
README.md
43
README.md
|
@ -1,24 +1,55 @@
|
|||
# Web
|
||||
Este proyecto consiste en un sitio web estático desarrollado con [Jekyll]() con el tema [no-style-please]() a modo de blog para realizar hablar del Software Libre y de Código Abierto.
|
||||
Este proyecto consiste en un sitio web estático desarrollado con [Jekyll]() con el tema [no-style-please](https://riggraz.dev/no-style-please/) a modo de blog para redactar sobre el Software Libre y de Código Abierto.
|
||||
|
||||
## Estructura
|
||||
El sitio web consta de una página inicial declarada solo con la cabecera como fichero en [Markdown]() en `index.md` y especificada en formato [YAML]() y situada en `_data/menu.yml` a modo de lista. En la misma, se declara los enlaces a las distintas publicaciones y resto de páginas del sitio.
|
||||
El sitio web consta de una página inicial declarada solo con la cabecera como fichero `index.md` en [Markdown](https://daringfireball.net/projects/markdown/) y especificada en formato [YAML](https://yaml.org/) y situada en `_data/menu.yml` a modo de lista. En la misma, se declara los enlaces a las distintas publicaciones y resto de páginas del sitio.
|
||||
|
||||
Adicionalmente, existe una página de redacción declarada en el fichero `redaction.md` donde se especifican las personas que redactan los artículos.
|
||||
|
||||
Las publicaciones, están escritas en Markdown, adjuntando una cabecera adicional descrita más adelante, y situadas en `_posts/`.
|
||||
|
||||
Por defecto, en la página inicial no se listan todas las publicaciones, sino que tienen un máximo definido y pasando al archivo cuando sobre pasa el límite. El archivo es un conjunto de ficheros en Markdown que constan de una única cabecera y están situados en `archive/`. Existe uno general y otro por cada categoría.
|
||||
|
||||
Las configuraciones generales del sitio se declaran en el fichero `_config.yml`, y el fichero Gemfile indica las dependencias de []() que necesita el sitio.
|
||||
Las configuraciones generales del sitio se declaran en el fichero `_config.yml`, y el fichero Gemfile indica las dependencias de [Ruby](https://www.ruby-lang.org/) que necesita el sitio.
|
||||
|
||||
## Funcionamiento
|
||||
|
||||
La web es actualizada cada 5 minutos usando un script en la [crontab]() del usuario donde estáá instalado Jekyll.
|
||||
La web es actualizada cada 5 minutos usando un script en la [crontab](https://pubs.opengroup.org/onlinepubs/007908775/xcu/crontab.html) del usuario donde estáá instalado Jekyll.
|
||||
|
||||
El script actualiza la copia del repositorio local, descarga o instala las dependencias de Ruby correspondientes y genera compila el sitio desde los ficheros fuente.
|
||||
|
||||
El script es el fichero `update.sh`.
|
||||
|
||||
## Contribución
|
||||
## Participación
|
||||
Cualquier persona puede participar en la redacción de artículos de este sitio web siguiendo las directrices especificadas posteriormente.
|
||||
|
||||
### Objetivos
|
||||
Si bien la descripción del sitio web ya da indicios de lo que se comenta, es conveniente aclarar cuales son los objetivos a cumplir al elaborar artículos.
|
||||
|
||||
Así como se mencionan, son objetivos, no reglas estrictas, dado que pueden existir casos en los que sea imposible evitar alguna, pero se aspirará a ello en la medida de lo posible.
|
||||
|
||||
Estos son:
|
||||
* Redactar exclusivamente de Software Libre y de Código Abierto
|
||||
* Utilizar una expresión natural y neutral
|
||||
* Ser neutral en asuntos agenos a lo que se redacta
|
||||
* No mencionar temas controvertidos
|
||||
* No realizar ataques a otros individuos
|
||||
|
||||
### Categorías
|
||||
Las categorías clasifican los artículos tema.
|
||||
|
||||
Existen 4 categorías iniciales:
|
||||
* Noticias
|
||||
* Promociones
|
||||
* Tutoriales
|
||||
* Opiniones
|
||||
|
||||
Para añadir nuevas categorías hay que llegar a un acuerdo entre todas y cada una de las personas que participan en la redacción. Una vez acordada, la categoría simplemente se empezará a utilizar en los nuevos artículos.
|
||||
|
||||
Adicionalmente, tras la creación de una categoría, es necesario añadir el listado de artículos a la página principal y crear su fichero de archivo.
|
||||
|
||||
### Páginas
|
||||
|
||||
|
||||
### Publicaciones
|
||||
#### Cabecera
|
||||
##### Fecha
|
||||
|
|
Loading…
Reference in New Issue