From 51df0a93c431e6ea80d3cd71bbd36e3e281e0819 Mon Sep 17 00:00:00 2001 From: Anchal Agarwal Date: Oct 12 2020 19:20:09 +0000 Subject: [PATCH 1/4] Update src/partials/footer-content.hbs Added Code of conduct link to footer of each page --- diff --git a/src/partials/footer-content.hbs b/src/partials/footer-content.hbs index 5528999..88f2680 100644 --- a/src/partials/footer-content.hbs +++ b/src/partials/footer-content.hbs @@ -1,4 +1,5 @@ From 0ae107bce3f6b4bfe8e3e1257f1af53b78723a15 Mon Sep 17 00:00:00 2001 From: anchal7299 Date: Oct 24 2020 18:39:38 +0000 Subject: [PATCH 2/4] Added NOTE to README.md --- diff --git a/README.md b/README.md index 3e77467..ce92c9c 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,26 @@ # fedora-docs-ui -Sources of a UI for the new Antora Docs site +Sources of a UI for the new Antora Docs site. + +This repo includes builder to build and preview the contents of this repository. ## Build and preview the UI -### Set up this builder +### Set up your project -Copy the `antora-ui-builder` to `~/bin/`: +Go to your Antora UI project directory. For example: ``` -$ cp antora-ui-builder ~/bin/ +$ git clone https://pagure.io/fedora-docs/fedora-docs-ui.git +$ antora-ui-test ``` -### Set up your project +### Set up this builder -Go to your Antora UI project directory. For example: +Copy the `antora-ui-builder` to `~/bin/`: ``` -$ git clone https://pagure.io/fedora-docs/fedora-docs-ui.git -$ antora-ui-test +$ cp antora-ui-builder ~/bin/ ``` Install the project dependencies: @@ -49,6 +51,8 @@ gulp.task('preview', ['build:preview'], () => Build a live preview: +**NOTE**: Please note that if you reference pages from other repositoreis, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions. + ``` $ antora-ui-builder gulp preview ``` @@ -61,4 +65,7 @@ If you want to use your UI on an Antora docs site, you need to build a bundle us $ antora-ui-builder gulp pack ``` -See the [Antora UI docs](https://docs.antora.org/antora-ui-default/build-preview-ui/) for more info. +Refer [Antora UI docs](https://docs.antora.org/antora-ui-default/build-preview-ui/) to build and preview content of this repository without script. + +**NOTE**: This repository currently supports node version 10.18.0 and gulp version 3.9.1 + From 796631eb2793b38f1fc6b8d5576aa02b96e21512 Mon Sep 17 00:00:00 2001 From: Anchal Agarwal Date: Oct 27 2020 10:10:31 +0000 Subject: [PATCH 3/4] Update antora-ui-builder --- diff --git a/antora-ui-builder b/antora-ui-builder index 17357a4..7eb9ada 100755 --- a/antora-ui-builder +++ b/antora-ui-builder @@ -2,7 +2,7 @@ if [ "$1" == "install" ]; then - cmd="yarn install" + cmd="npm install" elif [ "$1" == "preview" ]; then cmd="gulp preview" From 0eaf45786bd258b6543fde24c3fc5280087abe79 Mon Sep 17 00:00:00 2001 From: Anchal Agarwal Date: Oct 27 2020 10:48:33 +0000 Subject: [PATCH 4/4] Updates antora-ui-builder commands --- diff --git a/README.md b/README.md index ce92c9c..647ae36 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ This repo includes builder to build and preview the contents of this repository. ## Build and preview the UI +[Prerequisites](https://docs.antora.org/antora-ui-default/prerequisites/) + ### Set up your project Go to your Antora UI project directory. For example: @@ -26,7 +28,7 @@ $ cp antora-ui-builder ~/bin/ Install the project dependencies: ``` -$ antora-ui-builder yarn install +$ antora-ui-builder install ``` You also need to make a slight change to the configuration of your project so it works in a container. Open the `gulpfile.js` and add one new line `host: "0.0.0.0",` right below `port: 5252,` as shown below: @@ -54,7 +56,7 @@ Build a live preview: **NOTE**: Please note that if you reference pages from other repositoreis, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions. ``` -$ antora-ui-builder gulp preview +$ antora-ui-builder preview ``` Preview it on [localhost:5252](http://localhost:5252). @@ -62,10 +64,10 @@ Preview it on [localhost:5252](http://localhost:5252). If you want to use your UI on an Antora docs site, you need to build a bundle using the following command: ``` -$ antora-ui-builder gulp pack +$ antora-ui-builder pack ``` -Refer [Antora UI docs](https://docs.antora.org/antora-ui-default/build-preview-ui/) to build and preview content of this repository without script. +See the [Antora UI docs](https://docs.antora.org/antora-ui-default/build-preview-ui/) for more info. **NOTE**: This repository currently supports node version 10.18.0 and gulp version 3.9.1