Giter Club home page Giter Club logo

tapestry-antora-site-poc-content's Introduction

tapestry-antora-site-poc-content

About

Proof of concept of how the Tapestry website and documentation could be based on Antora. Intended for futher discussion with the Tapestry team.

This repo exclusively contains the website and documentation sources. See the tapestry-antora-site-poc-builder repo for how Antora is configured to build a static website from these sources.

Why isn't this hosted in an official Apache repo?

We may convert it into one eventually. To get started, this personal repo was a quick and easy for me to have a shared repo - essential for the intended Antora setup.

Migration Strategy

Currently, the Tapestry website is generated from a Confluence Wiki hosted by the Apache Software Foundation. In contrast, Antora works with Asciidoc sources. The strategy is to migrate the content manually.

  1. Copy the content from the current Tapestry website and paste it into the corresponding Asciidoc page.
  2. Enhance the source by recreating (i.e. adding missing) typography and by adding javadoc: and issue: macros where appropriate.
  3. Copy the Asciidoc page to the version branches.
  4. For each version branch, remove content no longer, or not yet, relevant for that branch.

Using automated scripts to convert Confluence sources to Asciidoc sources could be of some use. However, the larger part of the work is to split up the version-specific parts across the branches. Probably not worth the time to develop scripts for that.

Contributing

This is hosted on GitHub so please feel invited to send pull requests. If you would, please follow the One sentence per line principle.

tapestry-antora-site-poc-content's People

Contributors

vjlamp avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.