Giter Club home page Giter Club logo

antora-ocp-docs's Introduction

antora-ocp-docs

Based on https://github.com/stackrox/docs-tools/

  1. Run the transformation script:

    ./ocp-transform.sh -d build -b enterprise-4.10
  2. Make a new directory and copy the generated files:

    cd ~
    mkdir -p antora-ocp-test
    cp -r <path-to-dir>/build/ antora-ocp-test/
  3. Git init:

    cd antora-ocp-test
    git init
    git add .
    git commit -am 'Docs init'
  4. Run the Antora build:

    npx antora --fetch playbook.yml

To do:

  1. Use the patch-files script to patch xrefs in the generated files.
  2. Use the generate-nav script to generate the navigation.
  3. Add product-title and product-version variables in the common attributes file.
  4. Use an Antora playbook yml with the default UI bundle to generate the site.
  5. Check build warnings and errors.
  6. Add indexing and search capabilities.

antora-ocp-docs's People

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

aireilly

antora-ocp-docs's Issues

Build Antora site for OCP 4.10

Add, update, or create new scripts to build OCP docs site using Antora.
The script should be able to:

  • get files from either local openshift-docs repository or from GitHub
  • convert the files into the Antora required directory structure.
  • handle the xrefs
  • handle common attributes (_attributes)
  • auto-generate navigation from the _topic_map.yml file
  • generate required yml files (playbook.yml and antora.yml) that Antora needs for generating the site.

Acceptance criteria:
We should be able to run the Antora build command to generate the site and view docs.

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.