Foro de elhacker.net

Foros Generales => Foro Libre => Mensaje iniciado por: Eleкtro en 3 Enero 2016, 13:09 pm



Título: Hospedar documentación html de API, ¿donde?.
Publicado por: Eleкtro en 3 Enero 2016, 13:09 pm
¿Alguien me puede orientar sobre cual sería la mejor forma de hospedar la documentación html de una API?

Me refiero a tal vez registrarse en un hosting gratuito y crear el dominio web adrede, o quizás exista algún servicio gratuito que automatize la tarea de hospedar documentación html para tal fin... lo que seria de agradecer, ya que me da mucha, muchísima pereza hacer lo primero, así que... ¿conocen alguna alternativa?.

Esta es la documentación, por favor descargar y mirar el index.html si no entienden bien mi pregunta (son solo 15 mb):
http://www.mediafire.com/download/244x2i13vtp6j1d/Web.rar


Título: Re:
Publicado por: hksck en 4 Enero 2016, 23:29 pm
Sé que como opción ya te lo habrás planteado (o lo creo) y pregunto, GitHub (el cual por cierto rehuyo a más no poder por novato que soy) o sourceforge?



Enviado desde mi GT-S7580L mediante Tapatalk


Título: Re: Hospedar documentación html de API, ¿donde?.
Publicado por: #!drvy en 4 Enero 2016, 23:42 pm
Github sin duda, puedes hacerte una pagina html con su propio repositiorio usando Github Pages.
https://pages.github.com/

Saludos


Título: Re: Hospedar documentación html de API, ¿donde?.
Publicado por: .:UND3R:. en 4 Enero 2016, 23:52 pm
Github sin duda, puedes hacerte una pagina html con su propio repositiorio usando Github Pages.
https://pages.github.com/

Saludos

Aclamo la noción, inclusive si no la documentación en si en su primera instancia no es tan extensa, puedes usar inclusive el mismo readme del repositorio, aquí un ejemplo:

https://github.com/echonest/pyechonest/blob/master/README.md


Título: Re: Hospedar documentación html de API, ¿donde?.
Publicado por: Eleкtro en 8 Enero 2016, 21:12 pm
Gracias por las respuestas...

  • http://echonest.github.io/pyechonest/genindex.html

Pues vaya, eso me deja sorprendido, yo ya tengo una página en github pages (muy, muy cutre utilizando la plantilla por defecto) pero creia que era un servicio mucho más limitado...

de todas formas sigo sin saber como puedo hacer lo que quiero, si yo tengo todos los archivos en el disco local, y son miles de archivos... no voy a estar creando manualmente miles de páginas en el github pages, ¿como puedo montar el index.html en github pages?, ¿se puede subir el directorio con el contenido (los miles de archivos) de una sola vez?.

Saludos!


Título: Re: Hospedar documentación html de API, ¿donde?.
Publicado por: #!drvy en 8 Enero 2016, 22:36 pm
Citar
¿se puede subir el directorio con el contenido (los miles de archivos) de una sola vez?.

Si, mientras esten enlazados entre ellos no tendras ningun problema.

Saludos


Título: Re: Hospedar documentación html de API, ¿donde?.
Publicado por: Eleкtro en 9 Enero 2016, 13:26 pm
Por suerte he encontrado la solución en la sección de ayuda de GitHub:
  • GitHub pages basics (https://help.github.com/categories/github-pages-basics/)

En realidad desde el propio GitHub no se puede hacer, al menos no desde el servicio que ofrecen via online.

Para construir el sitio web teniendo una estructura local de los archivos html (con el index.html y el resto de archivos que componen la página en su totalidad), hay que utilizar la consola git.exe, siguiendo al pie de la letra los pasos de esta guía:
  • Creating Project Pages manually (https://help.github.com/articles/creating-project-pages-manually/)

Nota: En caso de que ya exista la página de GitHub del repositorio, para forzar la actualización y reemplazar la página hay que ignorar el comando que indica al final de la guía y utilizar este otro:
Código:
git push origin gh-pages -f

Creí que nunca lo conseguiría... ya que todos dicen que si, que era posible (no solo aquí, sino tambien en StackOverflow), pero nadie explicaba exactamente "a que botón darle" para hacerlo  y/o tampoco sabia cómo hacerlo.

¡Espero que esta información sirva para el futuro!.

Así es como me ha quedado :):
  • http://elektrostudios.github.io/ElektroKit/html/R_Project_ElektroKit.htm

PD: Lo se, debería modificar el index.html para crear una página principal con una presentación del proyecto y enlazar la página de la documentación aparte, todo a su tiempo.

Saludos!


Título: Re: Hospedar documentación html de API, ¿donde?.
Publicado por: #!drvy en 9 Enero 2016, 14:09 pm
Eso lo tienes que hacer en todos los proyectos excepto si estas acostumbrado a usar siempre la interfaz visual.

Ahí simplemente creaste el branch gh-pages que es el que actua de servidor web  :P

Utilizar Github via su interfaz grafica me parece que es perderse parate de la esencia de lo que es GIT en si.

Saludos


Título: Re: Hospedar documentación html de API, ¿donde?.
Publicado por: Eleкtro en 9 Enero 2016, 15:13 pm
Utilizar Github via su interfaz grafica me parece que es perderse parate de la esencia de lo que es GIT en si.

Si tuviese intención de dominar "la esencia" de git seguiría tu consejo (por que creo que eso fue un consejo xD), pero para el uso que le doy prefiero algo abstracto,
yo utilizo este cliente para Windows que me hace todas las tareas que necesito de una manera guiada y con el mínimo esfuerzo sin tener que documentarme sobre las bases o el funcionamiento de git en general (los branchs, pulls y demás), y también evito perder el tiempo con comandos o scripts en la interfáz command-line.

  • https://desktop.github.com/

( supongo que con esa aplicación tambien se podría crear la pagína de la API... pero no tengo ni idea. )

Para gustos colores, eso está claro.

Gracias por la ayuda

Saludos!