Skip to content

Commit 1a644fb

Browse files
committed
adapts Readme.adoc to OMP Default UI
Adapt the Readme.adoc to reference that the OMP Default UI is based on the fork and work from the Antora Default UI. In addition, mention changes and update copyright information.
1 parent aae0ae0 commit 1a644fb

File tree

2 files changed

+37
-19
lines changed

2 files changed

+37
-19
lines changed

README.adoc

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,31 @@
1-
= Antora Default UI
1+
= OMP Default UI (forked from Antora Default UI)
22
// Settings:
33
:experimental:
44
:hide-uri-scheme:
5-
// Project URLs:
5+
// OMP SDS Default UI URLS:
6+
:url-omp-ui-project: https://github.com/OpenManufacturingPlatform/sds-antora-ui.git
7+
// Antora Default UI URLs:
68
:url-project: https://gitlab.com/antora/antora-ui-default
79
:url-preview: https://antora.gitlab.io/antora-ui-default
8-
:url-ci-pipelines: {url-project}/pipelines
9-
:img-ci-status: {url-project}/badges/master/pipeline.svg
1010
// External URLs:
1111
:url-antora: https://antora.org
1212
:url-antora-docs: https://docs.antora.org
1313
:url-git: https://git-scm.com
1414
:url-git-dl: {url-git}/downloads
1515
:url-gulp: http://gulpjs.com
1616
:url-opendevise: https://opendevise.com
17+
:url-bci: https://www.bosch-connected-industry.com/de/en/index
1718
:url-nodejs: https://nodejs.org
1819
:url-nvm: https://github.com/creationix/nvm
1920
:url-nvm-install: {url-nvm}#installation
2021
:url-source-maps: https://developer.mozilla.org/en-US/docs/Tools/Debugger/How_to/Use_a_source_map
2122

22-
image:{img-ci-status}[CI Status (GitLab CI), link={url-ci-pipelines}]
23+
This project is an UI bundle implementing the style guide of the OMP (Open Manufacturing Platform). One can use the bundle to generate OMP styled documentation sites with {url-antora}[Antora].
24+
This OMP UI bundle is a customized fork of the {url-project}[Antora Default UI] project. Both projects are licensed under the MPL 2.0.
25+
The OMP Default UI bundle was initially created for generating documentations of the OMP SDS WG (Open Manufacturing Semantic Data Structuring Working Group) but can also be used by other OMP WGs and projects.
2326

24-
This project is an archetype that demonstrates how to produce a UI bundle that can be used by {url-antora}[Antora] to generated a documentation site.
25-
You can see a preview of the default UI at {url-preview}.
26-
27-
While the default UI is ready to be used with Antora, the intent is that you'll fork it and customize it for your own needs.
28-
It's intentionally minimalistic so as to give you a good starting point without requiring too much effort to customize.
29-
30-
== Use the Default UI
27+
////
28+
== Use the OMP SDS UI
3129

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

@@ -45,6 +43,7 @@ If the URL were to be unique, this setting would not be required.
4543

4644
Read on to learn how to customize the default UI for your own documentation.
4745

46+
////
4847
== Development Quickstart
4948
5049
This section offers a basic tutorial to teach you how to set up the default UI project, preview it locally, and bundle it for use with Antora.
@@ -121,10 +120,10 @@ Now that you have the prerequisites installed, you can fetch and build the UI pr
121120
Clone the default UI project using git:
122121
123122
[subs=attributes+]
124-
$ git clone {url-project} &&
123+
$ git clone {url-omp-ui-project} &&
125124
cd "`basename $_`"
126125
127-
The example above clones Antora's default UI project and then switches to the project folder on your filesystem.
126+
The example above clones the OMP SDS default UI project and then switches to the project folder on your filesystem.
128127
Stay in this project folder when executing all subsequent commands.
129128
130129
Use npm to install the project's dependencies inside the project.
@@ -203,11 +202,34 @@ In this case, the bundle will include the source maps, which can be used for deb
203202
204203
== Copyright and License
205204
206-
Copyright (C) 2017-2019 OpenDevise Inc. and the Antora Project.
205+
Copyright (C) 2020 - 2021 Robert Bosch Manufacturing Solutions GmbH
206+
207+
and
208+
209+
Copyright (C) 2017-2021 OpenDevise Inc. and the Antora Project.
207210
208211
Use of this software is granted under the terms of the https://www.mozilla.org/en-US/MPL/2.0/[Mozilla Public License Version 2.0] (MPL-2.0).
209212
See link:LICENSE[] to find the full license text.
210213
214+
The content in this project is a customized fork from {url-project}[Antora Default UI] which is developed by OpenDevise Inc. and the Antora Project. The fork is based on the commit with the id 64b526ba9fcd22d6c37dc834126a41c65cbbbe1d dated 04.01.2021.
215+
216+
217+
== OMP specific changes
218+
219+
In comparision, to the Antora Default UI this fork applies the following changes:
220+
221+
* add and apply OMP specific fonts
222+
* change colors in accordance to OMP color scheme
223+
* adapt Readme
224+
* add RDF/Turtle syntax highlighting
225+
* disable JavaScript linting
226+
* increase default body width
227+
* integrate lunr.js for search (lunr.js is developed in https://github.com/olivernn/lunr.js and licensed under the MIT license)
228+
229+
230+
211231
== Authors
212232
213233
Development of Antora is led and sponsored by {url-opendevise}[OpenDevise Inc].
234+
235+
The OMP specific adaptations to this OMP Default UI bundle were performed by {url-bci}[Robert Bosch Manufacturing Solutions GmbH].

README.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)