This is an automated email from the ASF dual-hosted git repository. djencks pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/aries-antora-ui.git
commit ea9439284b3bd64bc3cca143d525f4366d9c3f5e Author: David Jencks <[email protected]> AuthorDate: Fri Aug 14 09:47:17 2020 -0700 update .gitignore to admit that the bundle needs to be in git: update README with instructions --- .gitignore | 1 - README.adoc | 26 ++++++++++++++++++++++++-- build/aries-antora-ui-bundle.zip | Bin 298751 -> 296747 bytes 3 files changed, 24 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 977d53a..2180bc4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ -build node_modules public work diff --git a/README.adoc b/README.adoc index 8141cb9..99e5173 100644 --- a/README.adoc +++ b/README.adoc @@ -4,9 +4,31 @@ == Description -This ui bundle extension... +This ui bundle extension creates the UI bundle for Apache Aries. -== Usage +== Instructions for Aries site maintenance + +The Aries Antora website build uses the packed UI bundle built from these sources. +For the production build, this packed UI bundle must be available from the git repo accessed as a noe module. + +=== Production + +After you are satisfied with your local changes, run `gulp` and commit your changes and the modified `build/aries-antora-ui-bundle.zip`, and push to GitHub (or GitBox). +Aries website builds will now use the modifed UI. + +=== Local development + +After making changes, run `gulp;yarn pack`. +This will pack the UI bundle, including both sources and the build bundle, into a .tgz of a node module. +Modify the `package.json` file in `aries-antora` so the `"@apache-aries/aries-antora-ui"` devDependency points to this file. +For instance, on my system, this looks like this: + +[source,json] + "@apache-aries/aries-antora-ui": "file:///Users/david/projects/aries/aries-antora-ui/apache-aries-aries-antora-ui-v0.0.1.tgz" + +Running `npm run clean-build` will now build the site with the locally modified UI bundle. + +== Generic Usage To build a ui bundle based on the antora-ui-default sources with the additions from this extension, run `gulp`. diff --git a/build/aries-antora-ui-bundle.zip b/build/aries-antora-ui-bundle.zip index c3e3746..4394970 100644 Binary files a/build/aries-antora-ui-bundle.zip and b/build/aries-antora-ui-bundle.zip differ
