Otázka:
Služby hostování dokumentace API
axel22
2014-04-24 13:41:54 UTC
view on stackexchange narkive permalink

Jaké hostitelské služby existují, které umožňují bezplatné hostování dokumentace API? Mysli Travis pro CI nebo Bintray pro binární soubory, pouze pro dokumenty.

Jsem hledáme službu, která může pomoci automatizovat publikování dokumentace API - rádi bychom publikovali dokumenty jako součást naší nepřetržité integrace.

V ideálním případě by to mělo mít všechno následující, ale podmnožina těchto funkcí je v pořádku také:

  • by mělo být zdarma

  • má přiměřené množství prostoru pro hostování dokumentů

  • integrace s GitHub / Bitbucket je výhodou - jako Travis pracuje pro sestavování projektů, ale hostování generovaných dokumentů

  • má webové API pro nahrávání dokumentů, v takovém případě bychom použili Travise nebo Jenkinse k nahrání dokumentů po úspěšném sestavení

  • dokumentace API, kterou chceme publikovat, je pro projekt typu open-source

  • typ dokumentace by byl ScalaDoc pro Scala nebo JavaDoc pro Java, ale v ideálním případě by měl umožňovat nahrávání jakéhokoli druhu (HTML ) dokumenty

  • v ideálním případě by neměly být žádné reklamy nebo by neměly být příliš rušivé

Je to pro konkrétní jazyk? Bezplatné služby mají obvykle určité upozornění nebo agendu, ale mohou existovat některé, například Github, kde agendou jsou jednoduché bezplatné služby pro projekty s otevřeným zdrojem. Mohli byste tedy objasnit, zda je vaše API pro open-source nebo komerční projekt?
Rozhraní API by mělo být pro projekt open source, objasnění.
Je reklama v pořádku?
Tři odpovědi:
Nick Dickinson-Wilde
2014-04-26 07:46:47 UTC
view on stackexchange narkive permalink

Co třeba Stránky Github.

  • by mělo být zdarma: ano.
  • má přiměřený prostor pro hostování dokumentů: účinně neomezený pro dokumenty; měkký limit 1 GB na repo / 100 MB na soubor.
  • integrace s GitHub / Bitbucket je výhodou - jako Travis pracuje pro sestavení projektů, ale hostování vygenerovaných dokumentů: integrováno do Githubu.
  • má webové rozhraní API pro nahrávání dokumentů, v takovém případě bychom k úspěšnému sestavení nahráli dokumenty pomocí Travise nebo Jenkinse Můžete nahrajte jej pomocí příkazů git - nevím, jestli k tomu můžete použít Jenkinse nebo Travise.
  • typ dokumentace by byl ScalaDoc pro Scala nebo JavaDoc pro Java, ale v ideálním případě by měl umožňovat nahrávání jakéhokoli typu (HTML) dokumentů: Použil jsem pouze soubory Markdown (md), ale tato SO otázka popisuje použití Mavenu k nahrávání JavaDocs.
  • v ideálním případě by neměly být žádné reklamy nebo by neměly být příliš rušivé: bez reklam

Příkladem může být Stránky nápovědy Wrye Bash - zdroj stránek nápovědy je hostován v samostatném repo.

To není špatný nápad. Je pravda, že bychom měli pokaždé změnit historii, abychom zabránili tomu, aby úložiště příliš rostlo. S Jenkinsem nebo Travisem by to neměl být žádný problém - zvládne to buď bash skript, nebo úkol sestavovacího nástroje.
Tuto odpověď přijímám. Zdá se, že funguje dobře - mám skript, který zkontroluje repo dokumentace github do adresáře dočasnosti, zkopíruje tam dokumentaci, rebase a síla tlačí zpět do větve `gh-pages`. Pokud to dělá kdokoli jiný, vytvořte dočasný adresář (příkaz `mktemp`) a proveďte rebasing / force-push tam, jinak byste mohli zničit repo kódem.
sgoblin
2015-03-25 05:23:42 UTC
view on stackexchange narkive permalink

Dvě skvělé služby:

Read the Docs je velmi populární u open source projektů, zejména u projektů v Pythonu, protože je založen na Sphinx.

Viewdocs.io má méně funkcí a je méně populární, ale je pravděpodobně jednodušší, protože neexistují žádné účty, které by bylo možné nastavit, a nepodporuje reStructuredText.

DocsApp
2016-05-05 18:18:19 UTC
view on stackexchange narkive permalink

Stačí přidat další úžasnou službu docsapp.io

DocsApp poskytuje snadno použitelný editor značek, takže jej mohou používat i netechničtí uživatelé. Navíc je zdarma pro open source projekt.



ⓘ
Tyto otázky a odpovědi byly automaticky přeloženy z anglického jazyka.Původní obsah je k dispozici na webu stackexchange, za který děkujeme za licenci cc by-sa 3.0, pod kterou je distribuován.
Loading...