Skip to content

Commit

Permalink
Fix README and allow to set a release version and codename.
Browse files Browse the repository at this point in the history
  • Loading branch information
indigo423 committed Mar 8, 2019
1 parent aef85d0 commit 898ce22
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 83 deletions.
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ jobs:
steps:
- attach_workspace:
at: ~/

- run:
name: Push UI bundle archive to GitHub
command: |
ghr -replace -u ${GITHUB_USER} -r ${GITHUB_REPO} $(cat release.version) build/ui-bundle.zip
source release.version
ghr -replace -u "${GITHUB_USER}" -r "${GITHUB_REPO}" -n "${codename}" "v${release}" build/ui-bundle.zip
55 changes: 0 additions & 55 deletions .gitlab-ci.yml

This file was deleted.

40 changes: 15 additions & 25 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,37 +1,27 @@
= Antora Default UI
= Antora OpenNMS UI
// Settings:
:experimental:
:hide-uri-scheme:

// Project URLs:
:url-project: https://gitlab.com/antora/antora-ui-default
:url-preview: https://antora.gitlab.io/antora-ui-default
:url-ci-pipelines: {url-project}/pipelines
:img-ci-status: {url-project}/badges/master/pipeline.svg
// External URLs:
:url-project: https://github.com/opennms-forge/antora-ui-opennms
:url-antora: https://antora.org
:url-git: https://git-scm.com
:url-git-dl: {url-git}/downloads
:url-gulp: http://gulpjs.com
:url-opendevise: https://opendevise.com
:url-node: https://nodejs.org
:url-nvm: https://github.com/creationix/nvm
:url-nvm-install: {url-nvm}#installation
:url-yarn: https://yarnpkg.com
:url-ci-pipelines: https://circleci.com/gh/opennms-forge/workflows/antora-ui-opennms
:img-ci-status: https://circleci.com/gh/opennms-forge/antora-ui-opennms.svg?style=svg

image:{img-ci-status}[CI Status (GitLab CI), link={url-ci-pipelines}]

This project is an archetype that demonstrates how to produce a UI bundle for use in a documentation site generated with {url-antora}[Antora].
You can see a preview of the default UI at {url-preview}.

== Use the Default UI
== Use the OpenNMS Antora UI

If you want to use the default UI for your Antora-generated site, add the following UI configuration to your playbook:
If you want to use the UI for your Antora-generated site, add the following UI configuration to your playbook:

[source,yaml,subs=attributes+]
----
ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
url: https://github.com/opennms-forge/antora-ui-opennms/releases/download/v1.0.0/ui-bundle.zip
snapshot: true
----

Expand All @@ -46,18 +36,18 @@ A more comprehensive tutorial will be made available in the documentation.

To preview and bundle the default UI, you need the following software on your computer:

* {url-git}[git] (command: `git`)
* {url-node}[Node] (command: `node`)
* {url-gulp}[Gulp CLI] (command: `gulp`)
* {url-yarn}[Yarn] (command: `yarn`)
* command: `git`
* command: `node`
* command: `gulp`
* command: `yarn`

==== git

First, make sure you have git installed.

$ git --version

If not, {url-git-dl}[download and install] the git package for your system.
If not, download and install the git package for your system.

==== Node

Expand All @@ -69,7 +59,7 @@ If this command fails with an error, you don't have Node installed.
If the command doesn't report a Node LTS version (e.g., v10.14.2), you don't have a suitable version of Node installed.

While you can install Node from the official packages, we strongly recommend that you use {url-nvm}[nvm] (Node Version Manager) to install and manage Node.
Follow the {url-nvm-install}[nvm installation instructions] to set up nvm on your machine.
Follow the nvm installation instructions to set up nvm on your machine.

Once you've installed nvm, open a new terminal and install Node 10 using the following command:

Expand Down Expand Up @@ -173,4 +163,4 @@ See link:LICENSE[] to find the full license text.

== Authors

Development of Antora is led and sponsored by {url-opendevise}[OpenDevise Inc].
Development of Antora is led and sponsored by OpenDevise Inc.
3 changes: 2 additions & 1 deletion release.version
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
1.0.0
release="1.0.0"
codename="Stunt Car Racer"

0 comments on commit 898ce22

Please sign in to comment.