clean up README slightly, remove gitlab specific file master
authorDavid Jencks <djencks@apache.org>
Mon, 17 Aug 2020 22:43:35 +0000 (15:43 -0700)
committerDavid Jencks <djencks@apache.org>
Mon, 17 Aug 2020 22:43:35 +0000 (15:43 -0700)
.gitlab-ci.yml [deleted file]
README.adoc

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
deleted file mode 100644 (file)
index 36b15f9..0000000
+++ /dev/null
@@ -1,32 +0,0 @@
-image: node:10.20.1-stretch
-stages: [setup, verify, deploy]
-install:
-  stage: setup
-  cache:
-    paths:
-      - .cache/npm
-  script:
-    - &npm_install
-        npm install --quiet --no-progress --cache=.cache/npm
-lint:
-  stage: verify
-  cache: &pull_cache
-    policy: pull
-    paths:
-      - .cache/npm
-  script:
-    - *npm_install
-    - node_modules/.bin/gulp lint
-bundle-stable:
-  stage: deploy
-  only:
-    - master@djencks/aries-antora-ui
-  cache: *pull_cache
-  script:
-    - *npm_install
-    - node_modules/.bin/gulp bundle
-    - yarn pack
-  artifacts:
-    paths:
-      - aries-antora-aries-antora-ui-v*.tgz
-      - build/aries-antora-ui-ui-bundle.zip
index 884e93964a3e238d14ba2e60135098d5201f8a5e..6723877da2e9c037be95acdaa45900c08ae78ca3 100644 (file)
@@ -1,5 +1,5 @@
 = {extension}-ui ui bundle extension
-:extension: aries-antora-ui
+:extension: aries-antora
 :extension-version: 0.0.1
 
 WARNING: This repository contains files derived from the Antora Default UI, which is MPL2.0 licensed.
@@ -27,18 +27,30 @@ This will pack the UI bundle, including both sources and the build bundle, into
 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"
+[source,json,subs="+attributes"]
+    "@apache-aries/{extension}-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.
 
+== Converting this project to avoid usin `@djencks/antora-ui-builder`
+
+TODO: expand this
+
+For convenience, this project is initially set up to use `@djencks/antora-ui-builder` to extend the Antora default UI.
+If this is determined to be undesirable, it should be easy to turn this into a modified clone of the Antora default UI:
+
+* rename master to something else, such as `builder`.
+* Set the Antora Default UI as a remote.
+* Pull master from the Antora Default UI.
+* Copy the files from the builder branch, src, over the src directory on master.
+
 == Generic Usage
 
 To build a ui bundle based on the antora-ui-default sources with the additions from this extension, run `gulp`.
 
 To combine the UI elements from this extension with other elements, using `@djencks/antora-ui-builder`, include in your antora-ui.yml a clause such as:
 
-[source,yml,subs="+attributes]
+[source,yml,subs="+attributes"]
 ---
 sources:
   - path: antora-ui-default #replace or extend as needed