Login  Register

Re: Announcing Antora

Posted by mojavelinux on Dec 11, 2017; 7:15pm
URL: https://discuss.asciidoctor.org/Announcing-Antora-tp6049p6074.html

Thanks for your reply, Michael!

Do you intend to create a separate discussion forum for Antora? Or is this the place? 

Great question. We hadn't thought about that yet. For now, I'd say we can discuss here, since this project is very closely connected to the Asciidoctor ecosystem. Once the project matures a bit more, we'll likely look into having a dedicated forum and chat channel.

As a use of a dependency management system is familiar to most readers, maybe you could draw the parallel (and point out the differences) in a future blog post? 
One difference I am reading, is that in software development, the component is responsible for building (publishing) its re-usable artifacts.

What you're describing is exactly how Antora is designed to work. The current content aggregator happens to be looking for files in repository branches right now. But there's nothing preventing it from taking files from a published jar file instead (or in addition).

Where content is stored depends on the workflow of the organization. Some organizations use repository branches instead of published documentation artifacts (as they consider the latter to be too much process). Others publish artifacts, as you have suggested. Neither is right or wrong. It's just what works best for each group.

The cornerstone of Antora's pipeline, which will be covered in an upcoming article, is the virtual content catalog. After the content aggregation step, no subsequent component should touch the physical file system (or worry about fetching content). All the content should be in the virtual content catalog. This abstraction allows a myriad of choices as to where content is sourced. It could be a repository branch, a local file system, or the contents of a published archive. As we emphasize in the first article, content is sovereign.

Antora is proposing that the generator goes into the components repository and fetches what is needed. I feel that this blurs the demarcation of responsibilities, although is saves the need for an artifactory of some kind.

Antora is simply proposing that the generator collect content from disparate sources. Which sources, and how those sources are managed, is a choice the organization must make for themselves. Antora should support that choice, no matter what it is. We think using repository branches is the easiest and most elegant way to get started, but Antora can accommodate other arrangements too.

 I love the idea of a standard project structure for documentation. I hope this also results in guidelines to address issues like https://github.com/asciidoctor/asciidoctor/issues/894

Indeed.

Thanks again for the feedback!

-Dan 


On Sun, Dec 10, 2017 at 8:07 AM, Michael_M [via Asciidoctor :: Discussion] <[hidden email]> wrote:
Hi Dan,

I'm glad to see your Antora initiative. I'm sure this will also promote Asciidoc adoption.
Do you intend to create a separate discussion forum for Antora? Or is this the place?

I read the blog posts with the following use-case in mind: Creating user manuals for products which are built out of shared components. The components own their own documentation. A product is built out of specific versions of the components.

The software assembly requires a dependency management system (Maven, Gradle). It is not quite clear to me, why the document assembly would be different.
See this thread http://discuss.asciidoctor.org/Asciidoc-and-dependency-management-td3751.html, and the neo4j reference in it.

As a use of a dependency management system is familiar to most readers, maybe you could draw the parallel (and point out the differences) in a future blog post?
One difference I am reading, is that in software development, the component is responsible for building (publishing) its re-usable artifacts. Antara is proposing that the generator goes into the components repository and fetches what is needed. I feel that this blurs the demarcation of responsibilities, although is saves the need for an artifactory of some kind. Could you share your reasons for making this choice?

I love the idea of a standard project structure for documentation. I hope this also results in guidelines to address issues like https://github.com/asciidoctor/asciidoctor/issues/894

Thanks,
Michael


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Announcing-Antora-tp6049p6072.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Dan Allen | @mojavelinux | https://twitter.com/mojavelinux