Git Product home page Git Product logo

archiva-redback-components-site's Introduction

Archiva Redback Documentation - Component Documentation

How to build and publish the pages for the archiva web content

This module and the children contain web content and project reports that can be published to the archiva web site: https://archiva.apache.org

The web content parts of this module and submodules are published to the path

/redback/components/

Use the script

There is a shell script deploySite.sh which you can run to generate the site check and publish to the remote repository. It works only on Linux, on other platforms you have to go the next section.

The script is interactive, it asks you to confirm the publish after generation of the staging part.

Execute
./deploySite.sh

All arguments are appended to the mvn calls.

Run the mvn steps manually

Building the pages

You need enough free disk space to publish the web content. The archiva web site repository is big, but the maven build will only checkout the necessary directories for this build (sparse checkout).

For all the commands you have to change to this site directory:

cd redback-components/site
The following creates the site to the staging folder
mvn clean site
mvn site:stage

The result can be checked in

site/target/staging/redback/components/

with your browser.

If you would like the use a local checkout of the archiva-web-content.git repository and not push directly to the remote repository, you may add this parameter:

-DsiteRepositoryUrl=scm:git:file:///${path-to-your-local-archiva}/archiva-web-content.git

where ${path-to-your-local-archiva} is the path where a bare clone of the archiva-web-content.git is stored.

Note
You cannot use mvn site:run because this will place the submodules into the same folder and overwrite each other.

Publish the pages

This command publishes to the git repository
mvn scm-publish:publish-scm

After publishing to the git repository the gitpubsub mechanism is transferring it to the HTTP server.

If you would like the use a local checkout of the archiva-web-content.git repository and not push directly to the remote repository, you may add this parameter:

-DsiteRepositoryUrl=scm:git:file:///${path-to-your-local-archiva}/archiva-web-content.git

Some notes about the build process

A sparse checkout of the git repository will be created in

.site-content

but only, if the directory .site-content/.git does not exist.

archiva-redback-components-site's People

Contributors

effrafax 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.