You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by da...@apache.org on 2020/09/05 06:39:50 UTC

[logging-log4net] branch master updated: :memo: add documentation about building the log4net site

This is an automated email from the ASF dual-hosted git repository.

davydm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4net.git


The following commit(s) were added to refs/heads/master by this push:
     new 0d7b331  :memo: add documentation about building the log4net site
0d7b331 is described below

commit 0d7b331d875be1b55dba22253d801f3e70644bfa
Author: Davyd McColl <da...@gmail.com>
AuthorDate: Sat Sep 5 08:39:36 2020 +0200

    :memo: add documentation about building the log4net site
---
 BUILDING.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/BUILDING.md b/BUILDING.md
index 0a0cbd1..31abcc2 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -29,5 +29,15 @@ Options:
     included which (should) build if you set up AppVeyer to track
     your fork. AppVeyer is free for open-source projects.
     (TODO: should have a link to the official AppVeyer build)
-- build via the CircleCI Windows image. There is included configuration for CircleCI.
-    CicleCI is free (with usage limitations) for open-source projects.
\ No newline at end of file
+
+## Updating the site
+
+Log4Net uses Maven to build the site. Source artifacts can be found under `src/site`.
+Building the site can be accomplished with `npm run build-site`. You should have maven
+installed:
+- Windows: get it from Scoop
+- OSX: get it from Homebrew
+- Linux: use your package manager
+
+The site will be generated in `target/site`, and can be viewed locally. Updates should
+be pushed to the `asf-staging` branch of [https://github.com/apache/logging-log4net-site]()
\ No newline at end of file