uqbar-project / wiki Goto Github PK

View Code? Open in Web Editor NEW

3.0 18.0 5.0 42.97 MB

Uqbar Project Wiki

Home Page: http://wiki.uqbar.org

License: GNU Lesser General Public License v2.1

HTML 16.34% Ruby 27.32% JavaScript 2.82% Shell 0.43% TeX 0.35% Sass 48.65% SCSS 4.08%

wiki

wiki's Introduction

Uqbar wiki

Wiki armada en base a wiki.template de jekyll con algunos plugins, como git metadata, categorías, custom tags, etc.

Se puede ver todo lo que ofrece la wiki en terminos de implementación y features en este link

Instalacion local

Requerimientos

Para testear localmente se necesitan los siguientes requerimientos previos.

Ruby 2.5.0
Bundler
imagemagick
yarn
python

Instalando y levantando la wiki localmente

Para instalar las dependencias de ruby adicionales ejecutar:

bundle install

Este proyecto utiliza Jekyll, para levantar una instancia local una vez instaladas las dependencias habrá que instalar las dependencias adicionales mediante yarn:

yarn install

Una vez ya resueltas todas las dependencias se puede levantar el entorno mediante:

jekyll s --i

Esto arma un build local y una vez completado este proceso levanta localmente la instancia. De aquí en más se podrá hacer modificaciones localmente, y el servidor actualizará los cambios automáticamente (es lo que hace el flag --i de incremental).

Tener en cuenta que ante cualquier modificación fuera de los artículos, como los plugins, se necesitará ejecutar un nuevo build de jekyll. (El servidor se levantará por default en localhost:4000)

Rake tasks

Existen actualmente dos rake tasks

Generate

Esta rake task genera el build de los md, y genera en base a estos los html que servira despues jekyll.

Test

Esta rake task verifica los links que no autoreferencien a otras paginas de la wiki, o sea, links externos. Se tiene que tener el build ya armado ejecutando el generate o bien levantando el servicio previamente.

Publish

Esta rake task es tal vez la mas importante porque es la que usa el CI para publicar el build en gh-pages en el repo de github.

wiki's People

Contributors

Stargazers

Watchers

Forkers

mgarciaisaia vpennella bossiernesto guillep matiaslopez

wiki's Issues

Links caídos

La mayoría de los links que aparecen en el artículo de robustez de los lenguajes están caídos :(

Optimizar tiempos de jekyll watch

Con la cantidad de plugins y prechequeos activos (hook de html-proofer), incluso haciendo un watch --incremental, se esta demorando mucho tiempo entre cambios.

Ver de reducir estos de alguna manera

Armar hook para ejecutar htmlproofer cada vez que se actualiza una pagina localmente

Cuando se edite una pagina de la wiki locamente, levantando una instancia de jekyll, se debería tener un hook que ejecute a una instancia de HTML proofer para chequear si hay links externos caídos que deban corregirse. Esto ayudaria a detectar errores de url externos en una pagina antes de comittear los cambios al repositorio.

Add categories for an article

Each article can have one or more categories to start grouping them into categories. this will be a new parameter in the jekyll article descriptor

for eg

layout: article
title: Preparacion de un entorno de desarrollo java
categories: [java, enviroment]

also these categories should be present globally in the _config.yml in the line categories

for eg.

categories: [java, enviroment, scala, haskell, python, ruby, dds, paradigmas, tadp, algo3]

Add featured image for an article

Add featured article, taking an extra featured argument in the article jekyll page descriptor

for eg.

layout: article
title: Preparacion de un entorno de desarrollo java
featured: true

Traducir partes del layout de ingles a español

La wiki esta en español, pero hay partes como los botones de la barra, o en la sección de búsqueda, que estan en ingles. Traducir los nombres de estos botones y textos a español.

Links caidos

Cuando hice los cambios que estan en #23 vi que hay varios links caidos, que se hacen en los casos en los que nos da un 404? Buscamos si se actaulizaron por otros links?

esta es la lista

- /wiki/_site/wiki/articles/algo3-temario.html
  *  External link http://www.subcide.com/articles/creating-a-css-layout-from-scratch/P2/ failed: 404 No error
  *  External link https://github.com/uqbar-project/eg-conversor-react/tree/conversor-inmutable failed: 404 No error
  *  External link https://sites.google.com/site/programacionui/herramientas/arena?authuser=0 failed: 404 No error
  
- /wiki/_site/wiki/articles/android-introduccion.html
  *  External link https://phonegap.com/ failed: 403 No error

- /wiki/_site/wiki/articles/guia-de-instalacion-de-maven.html
  *  External link http://apache.dattatec.com/maven/maven-3/3.6.0/binaries/apache-maven-3.6.0-bin.tar.gz failed: 404 No error

- /wiki/_site/wiki/articles/herramientas-de-desarrollo-con-android.html
- /wiki/_site/wiki/articles/introduccion-a-las-metodologias-de-desarrollo-de-software.html
  *  External link https://csse.usc.edu/TECHRPTS/1988/usccse88-500/usccse88-500.pdf failed: got a time out (response code 0)

- /wiki/_site/wiki/articles/manejo-de-memoria-en-c.html
  *  External link http://svn2.xp-dev.com/svn/uqbar/examples/dds/estructurado/minilib failed: 404 No error

- /wiki/_site/wiki/articles/npm-dependencias.html
  *  External link https://docs.npmjs.com/misc/semver failed: 404 No error

- /wiki/_site/wiki/articles/resumen-lenguajes-prototipados.html
  *  External link https://en.wikipedia.org/wiki/Ioke_(programming_language) failed: 404 No error

- /wiki/_site/wiki/articles/robustez-de-los-lenguajes.html
  *  External link http://www.nrc.gov/ failed: got a time out (response code 0)

- /wiki/_site/wiki/articles/smalltalk.html
  *  External link http://www.esug.org/wiki/ failed: 502 No error
  *  External link http://www.esug.org/wiki/pier/Conferences/2011/Schedule-And-Talks/Native-boost failed: 502 No error
  *  External link http://www.seaside.st/ failed: got a time out (response code 0)

- /wiki/_site/wiki/articles/tipo-abstracto-de-datos.html
  *  External link http://svn2.xp-dev.com/svn/uqbar/examples/dds/estructurado/buffer failed: 404 No error

Cosas que quiero ver de hacerle

Hacer desaparecer la parte izquierda de la wiki. Esto también facilita que en celular no haya un header en todas las páginas.

En la navbar

En lugar de mostrar uqbar-wiki, poner el logo de uqbar que está en la parte izquierda. Incluso en el hover podría tener alguna animación, como ponerse más grande.
El logo puede tener el link directo a www.uqbar-project.org
Que la búsqueda tenga un ícono y el texto para buscar
Poner un ícono de una casa, o similar, para reflejar el Home.
Poner un ícono de lista, para Lista de artículos.

@PalumboN , algo más que se te ocurra mejorar? La otra vez me dijiste que tenías ideas...