New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a “Who's Using Asciidoctor?” page #270

Open
graphitefriction opened this Issue Aug 12, 2014 · 93 comments

Comments

Projects
None yet
@graphitefriction
Member

graphitefriction commented Aug 12, 2014

Also Include Issue #236

@recena

This comment has been minimized.

Show comment
Hide comment
@recena

recena Aug 19, 2014

Thanks in advance.

We are writing the documentation now, totally in process. But we have a custom template, custom look&feel and all together working in Continuous Integration.

Regards,

recena commented Aug 19, 2014

Thanks in advance.

We are writing the documentation now, totally in process. But we have a custom template, custom look&feel and all together working in Continuous Integration.

Regards,

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Aug 19, 2014

Member

Excellent! Then it will be a great example for the extent to which the output can be customized. I love it!

Member

mojavelinux commented Aug 19, 2014

Excellent! Then it will be a great example for the extent to which the output can be customized. I love it!

@recena

This comment has been minimized.

Show comment
Hide comment
@recena

recena Aug 19, 2014

Absolutely!

recena commented Aug 19, 2014

Absolutely!

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment

@mojavelinux mojavelinux changed the title from Create a Who is Using Asciidoctor page to Create a “Who's Using Asciidoctor?” page Aug 28, 2014

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@dobermai

This comment has been minimized.

Show comment
Hide comment
@dobermai

dobermai Aug 28, 2014

HiveMQ User Guide: hivemq.com/docs/hivemq/latest
HiveMQ Plugin Documentation: http://www.hivemq.com/docs/plugins/2.0.1/

HiveMQ User Guide: hivemq.com/docs/hivemq/latest
HiveMQ Plugin Documentation: http://www.hivemq.com/docs/plugins/2.0.1/

@emmanuelbernard

This comment has been minimized.

Show comment
Hide comment
@emmanuelbernard

emmanuelbernard Sep 1, 2014

Member

Hibernate website uses Asciidoctor for most pages http://hibernate.org.

Hibernate OGM, Hibernate Validator, Hibernate Search use Asciidoctor for their documentation.
They use the Maven plugin and wire it to the docbook backend while keeping the documentation in Asciidoc for faster editing.

Hibernate ORM uses Asciidoc for its topical guides

Member

emmanuelbernard commented Sep 1, 2014

Hibernate website uses Asciidoctor for most pages http://hibernate.org.

Hibernate OGM, Hibernate Validator, Hibernate Search use Asciidoctor for their documentation.
They use the Maven plugin and wire it to the docbook backend while keeping the documentation in Asciidoc for faster editing.

Hibernate ORM uses Asciidoc for its topical guides

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Feb 13, 2015

Member

Under the books category:

Member

mojavelinux commented Feb 13, 2015

Under the books category:

@cerker

This comment has been minimized.

Show comment
Hide comment

cerker commented Mar 30, 2015

Hibersap project: http://hibersap.org

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
Member

mojavelinux commented May 4, 2015

PsyToolkit - www.psytoolkit.org

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux May 4, 2015

Member

Taiga - http://taigaio.github.io/taiga-doc/dist/ (includes a custom HTML5 backend with an offcanvas navigation menu; source: https://github.com/taigaio/taiga-doc)

Member

mojavelinux commented May 4, 2015

Taiga - http://taigaio.github.io/taiga-doc/dist/ (includes a custom HTML5 backend with an offcanvas navigation menu; source: https://github.com/taigaio/taiga-doc)

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux May 7, 2015

Member

opendaylight - https://github.com/opendaylight/docs

They are using AsciiDoc to DocBook to generate the web help format.

Member

mojavelinux commented May 7, 2015

opendaylight - https://github.com/opendaylight/docs

They are using AsciiDoc to DocBook to generate the web help format.

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux May 9, 2015

Member

We should organize this list into books, software projects and perhaps other categories.

Member

mojavelinux commented May 9, 2015

We should organize this list into books, software projects and perhaps other categories.

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
Member

mojavelinux commented May 15, 2015

Another list can be found here: https://github.com/bodiam/awesome-asciidoc

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux May 19, 2015

Member

Apache HBase Reference Guide: https://hbase.apache.org/book.html

Member

mojavelinux commented May 19, 2015

Apache HBase Reference Guide: https://hbase.apache.org/book.html

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Jun 10, 2015

Member

arc42, software architecture - http://arc42.github.io/

Member

mojavelinux commented Jun 10, 2015

arc42, software architecture - http://arc42.github.io/

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Jun 15, 2015

Member

GroovyFX - http://groovyfx.org/docs/index.html
Weld - https://github.com/weld/core/tree/master/docs/reference/src/main/asciidoc (uses DocBook toolchain to build final output from Asciidoctror-generated DocBook)

Member

mojavelinux commented Jun 15, 2015

GroovyFX - http://groovyfx.org/docs/index.html
Weld - https://github.com/weld/core/tree/master/docs/reference/src/main/asciidoc (uses DocBook toolchain to build final output from Asciidoctror-generated DocBook)

@graphitefriction

This comment has been minimized.

Show comment
Hide comment
@graphitefriction

graphitefriction Jun 18, 2015

Member

I've sorted them into the following groups.

@mojavelinux Should I sort out Docs into websites and specs? Or are there better groupings?

Authors and Publishers

  • Enterprise Web Development: From Desktop to Mobile
  • Clojure Cookbook
  • NFJS, the Magazine
  • Python for Java
  • O’Reilly
  • MakerPress

Services

  • Noteshare.io
  • Hubpress.io
  • GitHub
  • GitLab
  • Atom Editor
  • Brackets Editor

Websites

  • Context and Dependency Injection for the Java EE Platform (CDI)
  • Hibernate

Docs

  • Git user manual (Via git-scm.com)
  • Bintray REST API and User Guide
  • Griffon Guide
  • Spring Framework (Core, Data, Security, XD and more)
  • Spring's Getting Started Guides
  • OpenShift
  • Clinker
  • Granite DS
  • Mule ESB
  • Infinispan
  • Groovy
  • TomEE refcard
  • HiveMQ User Guide
  • HiveMQ Plugin Documentation
  • Hibernate OGM, Hibernate Validator, Hibernate Search
  • Hibernate ORM
  • Stardog
  • Activiti
  • Anki
  • AnkiDroid
  • Reactor
  • Hibersap
  • PsyToolkit
  • Taiga
  • AjaxAnywhere
  • opendaylight
  • Eclipse Scout
  • Apache HBase Reference Guide
  • Java for Kids
  • arc42
  • Vert.x 3
  • GroovyFX
  • Weld

Specifications

  • Context and Dependency Injection for the Java EE Platform (CDI)
  • JavaMoney

Also, I need a status update on the following two:

  • Golo Programming Language Guide (AsciiDoc Python, soon to be Asciidoctor!)
  • Phusion Passenger Users Guides (AsciiDoc Python)
Member

graphitefriction commented Jun 18, 2015

I've sorted them into the following groups.

@mojavelinux Should I sort out Docs into websites and specs? Or are there better groupings?

Authors and Publishers

  • Enterprise Web Development: From Desktop to Mobile
  • Clojure Cookbook
  • NFJS, the Magazine
  • Python for Java
  • O’Reilly
  • MakerPress

Services

  • Noteshare.io
  • Hubpress.io
  • GitHub
  • GitLab
  • Atom Editor
  • Brackets Editor

Websites

  • Context and Dependency Injection for the Java EE Platform (CDI)
  • Hibernate

Docs

  • Git user manual (Via git-scm.com)
  • Bintray REST API and User Guide
  • Griffon Guide
  • Spring Framework (Core, Data, Security, XD and more)
  • Spring's Getting Started Guides
  • OpenShift
  • Clinker
  • Granite DS
  • Mule ESB
  • Infinispan
  • Groovy
  • TomEE refcard
  • HiveMQ User Guide
  • HiveMQ Plugin Documentation
  • Hibernate OGM, Hibernate Validator, Hibernate Search
  • Hibernate ORM
  • Stardog
  • Activiti
  • Anki
  • AnkiDroid
  • Reactor
  • Hibersap
  • PsyToolkit
  • Taiga
  • AjaxAnywhere
  • opendaylight
  • Eclipse Scout
  • Apache HBase Reference Guide
  • Java for Kids
  • arc42
  • Vert.x 3
  • GroovyFX
  • Weld

Specifications

  • Context and Dependency Injection for the Java EE Platform (CDI)
  • JavaMoney

Also, I need a status update on the following two:

  • Golo Programming Language Guide (AsciiDoc Python, soon to be Asciidoctor!)
  • Phusion Passenger Users Guides (AsciiDoc Python)
@graphitefriction

This comment has been minimized.

Show comment
Hide comment
@graphitefriction

graphitefriction Jun 19, 2015

Member

Wireframe 1

Note: This is a wireframe, that's why there are gray boxes around the components. It's not a hi-fi mockup.

Note: The highlighted service, docs project, book, etc would change with each visit (i.e. we'd rotate them through a script <- but I don't mean via carousels, carousels are dirty 💩 )

mock_1

Member

graphitefriction commented Jun 19, 2015

Wireframe 1

Note: This is a wireframe, that's why there are gray boxes around the components. It's not a hi-fi mockup.

Note: The highlighted service, docs project, book, etc would change with each visit (i.e. we'd rotate them through a script <- but I don't mean via carousels, carousels are dirty 💩 )

mock_1

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Jun 19, 2015

Member

Fantastic!!

Member

mojavelinux commented Jun 19, 2015

Fantastic!!

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Jun 19, 2015

Member

I think it's good to have the specs be a separate category because it sends a strong message. Though, this category may evolve overtime to be something more general (for instance, it could incorporate documents in other enterprises like legal).

We'll probably want to sort the Docs category by how well the entries serve as an example so people discover the ones first that show Asciidoctor in the best light. We'll also need to think about how best to handle the Spring entries since it encompasses many great examples of Asciidoctor in action.

Member

mojavelinux commented Jun 19, 2015

I think it's good to have the specs be a separate category because it sends a strong message. Though, this category may evolve overtime to be something more general (for instance, it could incorporate documents in other enterprises like legal).

We'll probably want to sort the Docs category by how well the entries serve as an example so people discover the ones first that show Asciidoctor in the best light. We'll also need to think about how best to handle the Spring entries since it encompasses many great examples of Asciidoctor in action.

@graphitefriction

This comment has been minimized.

Show comment
Hide comment
@graphitefriction

graphitefriction Jun 19, 2015

Member

Alt form of Wireframe 1

Somethings a little "meh" about the spacing in this one, but it could work because the "mores" in each category (like books) would only be a few, but for docs, there'd be a lot listed....hmmmmm

mock_2

Member

graphitefriction commented Jun 19, 2015

Alt form of Wireframe 1

Somethings a little "meh" about the spacing in this one, but it could work because the "mores" in each category (like books) would only be a few, but for docs, there'd be a lot listed....hmmmmm

mock_2

@graphitefriction

This comment has been minimized.

Show comment
Hide comment
@graphitefriction

graphitefriction Jun 19, 2015

Member

Maybe what it is missing is big, centered section headings like THE DOCS! THE BOOKS! THE SERVICES! THE JAZZ HANDS!

Member

graphitefriction commented Jun 19, 2015

Maybe what it is missing is big, centered section headings like THE DOCS! THE BOOKS! THE SERVICES! THE JAZZ HANDS!

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Jun 19, 2015

Member

Keep in mind, we could use an accordion to reveal the “more” list. We could even use one of those partially shown accordions like you see on news site (we hate them there, but here it would actually make sense).

Member

mojavelinux commented Jun 19, 2015

Keep in mind, we could use an accordion to reveal the “more” list. We could even use one of those partially shown accordions like you see on news site (we hate them there, but here it would actually make sense).

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@jaredmorgs

This comment has been minimized.

Show comment
Hide comment
@jaredmorgs

jaredmorgs Jan 23, 2016

Member

So we don't want to put these into the User Guide as a reference point, right? These links will be curated and managed on the website?

Member

jaredmorgs commented Jan 23, 2016

So we don't want to put these into the User Guide as a reference point, right? These links will be curated and managed on the website?

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Jan 26, 2016

Member

Yes, I think this will be a dedicated page. And certainly one that needs to be more organized than this comment thread 😉

Member

mojavelinux commented Jan 26, 2016

Yes, I think this will be a dedicated page. And certainly one that needs to be more organized than this comment thread 😉

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Feb 1, 2016

Member

Atom
documentation: https://github.com/atom/docs
site: https://atom.io/docs/latest/using-atom-writing-in-atom

Technically, the Atom docs are built with Atlas, but Atlas (presumably) uses Asciidoctor under the covers.

Member

mojavelinux commented Feb 1, 2016

Atom
documentation: https://github.com/atom/docs
site: https://atom.io/docs/latest/using-atom-writing-in-atom

Technically, the Atom docs are built with Atlas, but Atlas (presumably) uses Asciidoctor under the covers.

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Feb 10, 2016

Member

Kudu
documentation: http://getkudu.io/docs/

One of several Cloudera-supported projects using Asciidoctor.

Member

mojavelinux commented Feb 10, 2016

Kudu
documentation: http://getkudu.io/docs/

One of several Cloudera-supported projects using Asciidoctor.

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Feb 13, 2016

Member

Believe it or not, the new Drupal user guide is written in AsciiDoc.

Source: http://cgit.drupalcode.org/user_guide/tree/
Site: https://www.drupal.org/project/user_guide (follow link to user guie)

Member

mojavelinux commented Feb 13, 2016

Believe it or not, the new Drupal user guide is written in AsciiDoc.

Source: http://cgit.drupalcode.org/user_guide/tree/
Site: https://www.drupal.org/project/user_guide (follow link to user guie)

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Feb 19, 2016

Member

InfoQ mini-books:

http://www.infoq.com/minibook-guidelines

The first mini-book to be published based on Asciidoctor was the JHipster Mini-Book, written by Matt Raible (who, incidentally, also setup the template for InfoQ).

http://www.infoq.com/minibooks/jhipster-mini-book

Member

mojavelinux commented Feb 19, 2016

InfoQ mini-books:

http://www.infoq.com/minibook-guidelines

The first mini-book to be published based on Asciidoctor was the JHipster Mini-Book, written by Matt Raible (who, incidentally, also setup the template for InfoQ).

http://www.infoq.com/minibooks/jhipster-mini-book

@jmini

This comment has been minimized.

Show comment
Hide comment
@jmini

jmini Mar 14, 2016

Contributor

Become a ninja with Angular 2 (online book [EPUB, MOBI, PDF, HTML], closed source, free samples available).

@cexbrayat discuss the approach and the benefits of the toolchain in the French Podcast LCC 142 (last 8 minutes, start at 1:14:06)

Contributor

jmini commented Mar 14, 2016

Become a ninja with Angular 2 (online book [EPUB, MOBI, PDF, HTML], closed source, free samples available).

@cexbrayat discuss the approach and the benefits of the toolchain in the French Podcast LCC 142 (last 8 minutes, start at 1:14:06)

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Mar 25, 2016

Member

RedPen User Manual

Source: https://github.com/redpen-cc/redpen-doc
Site: http://redpen.cc/docs/latest/index.html

(Presents a nice custom theme).

Member

mojavelinux commented Mar 25, 2016

RedPen User Manual

Source: https://github.com/redpen-cc/redpen-doc
Site: http://redpen.cc/docs/latest/index.html

(Presents a nice custom theme).

@njbartlett

This comment has been minimized.

Show comment
Hide comment
@njbartlett

njbartlett Apr 8, 2016

Effective OSGi. Just starting up but the tool is working out really well so far. Thanks!

Effective OSGi. Just starting up but the tool is working out really well so far. Thanks!

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@ciampix

This comment has been minimized.

Show comment
Hide comment
@ciampix

ciampix May 26, 2016

GEGL from the GIMP project uses asciidoc for documentation, see: http://gegl.org/

ciampix commented May 26, 2016

GEGL from the GIMP project uses asciidoc for documentation, see: http://gegl.org/

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
Member

mojavelinux commented Jun 17, 2016

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Jul 11, 2016

Member

eXo developer resources:: http://developer.exoplatform.org/ cc: @mgreau

Member

mojavelinux commented Jul 11, 2016

eXo developer resources:: http://developer.exoplatform.org/ cc: @mgreau

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Feb 27, 2017

Member

Docker Maven Plugin - https://dmp.fabric8.io/

Member

mojavelinux commented Feb 27, 2017

Docker Maven Plugin - https://dmp.fabric8.io/

@ciampix

This comment has been minimized.

Show comment
Hide comment
@ciampix

ciampix Mar 5, 2017

The Git Book (pro git 2) is written, published and translated using Asciidoc(tor):
https://git-scm.com/book/en/v2
https://github.com/progit/progit2

ciampix commented Mar 5, 2017

The Git Book (pro git 2) is written, published and translated using Asciidoc(tor):
https://git-scm.com/book/en/v2
https://github.com/progit/progit2

@ciampix

This comment has been minimized.

Show comment
Hide comment
@ciampix

ciampix Mar 21, 2017

New Arduino web cloud editor interface uses Asciidoc format for new project ReadMe.adoc by default.

ciampix commented Mar 21, 2017

New Arduino web cloud editor interface uses Asciidoc format for new project ReadMe.adoc by default.

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

mojavelinux Mar 28, 2017

Member

Vulkan by KhronosGroup (specifically Asciidocotor PDF): https://github.com/KhronosGroup/Vulkan-Docs/tree/1.0/doc/specs/vulkan

Member

mojavelinux commented Mar 28, 2017

Vulkan by KhronosGroup (specifically Asciidocotor PDF): https://github.com/KhronosGroup/Vulkan-Docs/tree/1.0/doc/specs/vulkan

@abelsromero

This comment has been minimized.

Show comment
Hide comment
@abelsromero

abelsromero Apr 12, 2017

Member

Vaadin web framework uses Asciidoctor: https://vaadin.com/docs/.
It also has some nice guides about styling and tools for contributing: https://vaadin.com/docs/-/part/contributing/overview.html.

Member

abelsromero commented Apr 12, 2017

Vaadin web framework uses Asciidoctor: https://vaadin.com/docs/.
It also has some nice guides about styling and tools for contributing: https://vaadin.com/docs/-/part/contributing/overview.html.

@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@mojavelinux

This comment has been minimized.

Show comment
Hide comment
@m-czernek

This comment has been minimized.

Show comment
Hide comment
@m-czernek

m-czernek Sep 25, 2017

JBPM, Drools, and Optaplanner (upstream)

source (for all): https://github.com/kiegroup/kie-docs

JBPM, Drools, and Optaplanner (upstream)

source (for all): https://github.com/kiegroup/kie-docs

@bexelbie

This comment has been minimized.

Show comment
Hide comment

Fedora Docs: https://docs.fedoraproject.org

@bprioux

This comment has been minimized.

Show comment
Hide comment
@bprioux

bprioux Sep 26, 2017

Red Hat Documentation, created and managed by members of Red Hat's Product Documentation teams, is an open-source hub for Red Hat's evolving documentation standards. The GitHub location includes asciidoc templates used in Modular Documentation Project work and asciidoc markup conventions.

bprioux commented Sep 26, 2017

Red Hat Documentation, created and managed by members of Red Hat's Product Documentation teams, is an open-source hub for Red Hat's evolving documentation standards. The GitHub location includes asciidoc templates used in Modular Documentation Project work and asciidoc markup conventions.

@ciampix

This comment has been minimized.

Show comment
Hide comment
@ciampix

ciampix Sep 27, 2017

AsciiBinder is a documentation system built on Asciidoctor for people who have a lot of docs to maintain and republish on a regular basis. AsciiBinder was specifically developed to solve two problems at once:

  • Make it easier for developers and community members to contribute documentation.
  • Make it easier for content managers to build and publish several variants of the same documentation.

ciampix commented Sep 27, 2017

AsciiBinder is a documentation system built on Asciidoctor for people who have a lot of docs to maintain and republish on a regular basis. AsciiBinder was specifically developed to solve two problems at once:

  • Make it easier for developers and community members to contribute documentation.
  • Make it easier for content managers to build and publish several variants of the same documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment