PR#12: Added Code of conduct link to footer of each page - fedora-docs/fedora-docs-ui

fedora-docs / fedora-docs-ui

#12 Added Code of conduct link to footer of each page

Closed 2 years ago by darknao. Opened 3 years ago by anchal7299.

fedora-docs/ anchal7299/fedora-docs-ui master into main

Updates antora-ui-builder commands

Anchal Agarwal • 3 years ago

0eaf457

Update antora-ui-builder

Anchal Agarwal • 3 years ago

796631e

Added NOTE to README.md

anchal7299 • 3 years ago

0ae107b

Update src/partials/footer-content.hbs

Anchal Agarwal • 3 years ago

51df0a9

README.md

file modified

+21 -12

		`@@ -1,16 +1,12 @@`
		`# fedora-docs-ui`

		`- Sources of a UI for the new Antora Docs site`
		`+ Sources of a UI for the new Antora Docs site.`

		`- ## Build and preview the UI`
		`-`
		`- ### Set up this builder`
		`+ This repo includes builder to build and preview the contents of this repository.`

		- Copy the `antora-ui-builder` to `~/bin/`:
		`+ ## Build and preview the UI`

		- ```
		`- $ cp antora-ui-builder ~/bin/`
		- ```
		`+ [Prerequisites](https://docs.antora.org/antora-ui-default/prerequisites/)`

		`### Set up your project`

		`@@ -21,10 +17,18 @@`
		`$ antora-ui-test`
		```

		`+ ### Set up this builder`
		`+`
		+ Copy the `antora-ui-builder` to `~/bin/`:
		`+`
		+ ```
		`+ $ 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:
		`@@ -49,8 +53,10 @@`

		`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).`
		`@@ -58,7 +64,10 @@`
		`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`
		```

		`- See the [Antora UI docs](https://docs.antora.org/antora-ui-default/build-preview-ui/) for more info.`
		`+ 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`
		`+`

antora-ui-builder

file modified

+1 -1

		`@@ -2,7 +2,7 @@`


		`if [ "$1" == "install" ]; then`
		`- cmd="yarn install"`
		`+ cmd="npm install"`

		`elif [ "$1" == "preview" ]; then`
		`cmd="gulp preview"`

src/partials/footer-content.hbs

file modified

		`@@ -1,4 +1,5 @@`
		`<footer class="footer">`
		`<p>All Fedora Documentation content available under <a href="http://creativecommons.org/licenses/by-sa/3.0/legalcode">CC-BY-SA 3.0</a> or, when specifically noted, under another <a href="https://fedoraproject.org/wiki/Licensing:Main">accepted</a> free and open content license.</p>`
		`<p>Last build: {{{env.ANTORA_DATE}}}</p>`
		`+ <p><a href="https://docs.fedoraproject.org/en-US/project/code-of-conduct/index.html">Code of Conduct</a></p>`
jibecfed commented 3 years ago I don't feel like these kind of links work with internationalization. I think the "url" variable should be usable here: https://docs.antora.org/antora/2.3/playbook/environment-variables/
		`</footer>`

anchal7299 commented 3 years ago

Fixed: https://pagure.io/fedora-docs/docs-fp-o/issue/132

1 new commit added

Added NOTE to README.md

3 years ago

2 new commits added

Updates antora-ui-builder commands
Update antora-ui-builder

3 years ago

jibecfed commented on line 5 of src/partials/footer-content.hbs 3 years ago

I don't feel like these kind of links work with internationalization.
I think the "url" variable should be usable here: https://docs.antora.org/antora/2.3/playbook/environment-variables/