Skip to content

Commit dbf080e

Browse files
oddhackoddhack
committed
Merge KhronosGroup/antora-ui-khronos repository into KhronosGroup/Vulkan-Site
The purpose is to avoid all the annoyances introduced by a dependency which will always be built with the site build anyway. In particular, any PR against Vulkan-Site which relies on a UI submodule update and persists for any length of time will quickly generate conflicts with every other such PR. It should still be possible to merge with the upstream https://gitlab.com/antora/antora-ui-default[Antora Default UI] repository if and when we want to. - Resolved README.adoc conflict by moving the site file into README.Khronos.adoc - Resolve .gitignore content by merging filters for both repos - Removed antora-ui-khronos submodule, since it's now part of and built from this branch - Need to update REUSE configuration and LICENSES / CONTRIBUTING / COPYING files - Need to modify Github Actions CI scripts to build the UI locally - Can consider repackaging Vulkan-Site into a subdirectory for a cleaner separation Adds the following files and directories from antora-ui-khronos: - .editorconfig - .eslint* - .gitlab-ci.yml (UI build in upstream gitlab) - .gulp.json - .nvmrc - .stylelintrc - LICENSE - docs/* - gulp.d/* - index.js - package-lock.json - package.json - preview-src/* - src/* Retains the following files and directories from Vulkan-Site: - .github/* (Site build in github) - .reuse - LICENSES - docs-site - CODE_OF_CONDUCT.adoc - CONTRIBUTING.adoc - COPYING.adoc - LICENSE.adoc - Makefile - README.adoc
2 parents 0814b14 + 0025e01 commit dbf080e

File tree

148 files changed

+28685
-106
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+28685
-106
lines changed

‎.editorconfig‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true

‎.eslintignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
split.js

‎.eslintrc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"extends": "standard",
3+
"rules": {
4+
"arrow-parens": ["error", "always"],
5+
"comma-dangle": ["error", {
6+
"arrays": "always-multiline",
7+
"objects": "always-multiline",
8+
"imports": "always-multiline",
9+
"exports": "always-multiline"
10+
}],
11+
"no-restricted-properties": ["error", {
12+
"property": "substr",
13+
"message": "Use String#slice instead."
14+
}],
15+
"max-len": [1, 120, 2],
16+
"spaced-comment": "off",
17+
"radix": ["error", "always"]
18+
}
19+
}

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# Upstream .gitignore
2+
/build/
3+
/node_modules/
4+
/public/
5+
# Khronos .gitignore
16
docs-site/js/*.cjs
27
docs-site/build
38
/docs-site/node_modules/

‎.gitlab-ci.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
image: node:10.14.2-stretch
2+
stages: [setup, verify, deploy]
3+
install:
4+
stage: setup
5+
cache:
6+
paths:
7+
- .cache/npm
8+
script:
9+
- &npm_install
10+
npm install --quiet --no-progress --cache=.cache/npm
11+
lint:
12+
stage: verify
13+
cache: &pull_cache
14+
policy: pull
15+
paths:
16+
- .cache/npm
17+
script:
18+
- *npm_install
19+
- node_modules/.bin/gulp lint
20+
bundle-stable:
21+
stage: deploy
22+
only:
23+
- master@antora/antora-ui-default
24+
cache: *pull_cache
25+
script:
26+
- *npm_install
27+
- node_modules/.bin/gulp bundle
28+
artifacts:
29+
paths:
30+
- build/ui-bundle.zip
31+
bundle-dev:
32+
stage: deploy
33+
except:
34+
- master
35+
cache: *pull_cache
36+
script:
37+
- *npm_install
38+
- node_modules/.bin/gulp bundle
39+
artifacts:
40+
expire_in: 1 day # unless marked as keep from job page
41+
paths:
42+
- build/ui-bundle.zip
43+
pages:
44+
stage: deploy
45+
only:
46+
- master@antora/antora-ui-default
47+
cache: *pull_cache
48+
script:
49+
- *npm_install
50+
- node_modules/.bin/gulp preview:build
51+
# FIXME figure out a way to avoid copying these files to preview site
52+
- rm -rf public/_/{helpers,layouts,partials}
53+
artifacts:
54+
paths:
55+
- public

‎.gitmodules‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +0,0 @@
1-
[submodule "antora-ui-khronos"]
2-
path = antora-ui-khronos
3-
url = ../antora-ui-khronos

‎.gulp.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"description": "Build tasks for the Antora default UI project",
3+
"flags.tasksDepth": 1
4+
}

‎.nvmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
10

‎.stylelintrc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"extends": "stylelint-config-standard",
3+
"rules": {
4+
"comment-empty-line-before": null,
5+
"no-descending-specificity": null,
6+
}
7+
}

0 commit comments

Comments
 (0)