Skip to content

Commit

Permalink
[gh-pages] reskin registry site and prep for release
Browse files Browse the repository at this point in the history
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
  • Loading branch information
MikeRalphson committed Mar 23, 2023
1 parent f915f09 commit 4a90c90
Show file tree
Hide file tree
Showing 22 changed files with 103 additions and 47 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ FROM bretfisher/jekyll-serve
WORKDIR /site

# install dependencies
COPY Gemfile Gemfile.lock .
COPY Gemfile Gemfile.lock ./
RUN bundle install

# install the site
Expand Down
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ source "https://rubygems.org"
gem "jekyll", "~> 4.2"
gem "webrick", "~> 1.7"
gem "jekyll-remote-theme"
gem "jekyll-theme-dinky"
gem "just-the-docs", "~> 0.4.2"

group :jekyll_plugins do
gem "jekyll-sitemap", "~> 1.4"
Expand Down
21 changes: 12 additions & 9 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ GEM
eventmachine (1.2.7)
ffi (1.15.5)
forwardable-extended (2.6.0)
google-protobuf (3.22.2-x86_64-linux)
google-protobuf (3.22.2)
http_parser.rb (0.8.0)
i18n (1.12.0)
concurrent-ruby (~> 1.0)
Expand Down Expand Up @@ -42,11 +42,12 @@ GEM
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-theme-dinky (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
just-the-docs (0.4.2)
jekyll (>= 3.8.5)
jekyll-seo-tag (>= 2.0)
rake (>= 12.3.1)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
Expand All @@ -59,29 +60,31 @@ GEM
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.1)
rake (13.0.6)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (4.1.0)
rouge (3.30.0)
rubyzip (2.3.2)
safe_yaml (1.0.5)
sass-embedded (1.59.2-x86_64-linux-gnu)
sass-embedded (1.58.3)
google-protobuf (~> 3.21)
rake (>= 10.0.0)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.4.2)
webrick (1.8.1)

PLATFORMS
x86_64-linux
ruby

DEPENDENCIES
jekyll (~> 4.2)
jekyll-remote-theme
jekyll-sitemap (~> 1.4)
jekyll-theme-dinky
just-the-docs (~> 0.4.2)
webrick (~> 1.7)

BUNDLED WITH
2.4.7
1.17.2
36 changes: 33 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
theme: jekyll-theme-dinky
title: OpenAPI Initiative Registry - DRAFT CONTENT
# theme: just-the-docs
remote_theme: just-the-docs/just-the-docs
color_scheme: oai
title: OpenAPI Initiative Registry
description: Extensible data value repository
show_downloads: true
collections_dir: /registries
Expand All @@ -18,7 +20,8 @@ collections:
extension:
slug: extension
name: Specification Extension Registry
output: true
output: false
hidden: true
permalink: /registry/:collection/:title
draft-feature:
slug: draft-feature
Expand All @@ -35,3 +38,30 @@ collections:
name: Extension Namespace Registry
output: true
permalink: /registry/:collection/:title
exclude:
- Gemfile
- Gemfile.lock
- tmp
- vendor/bundle
#just_the_docs:
# collections:
# draft-feature:
# name: Draft features
# alternative-schema:
# name: Alternative schemas
# namespace:
# name: Extension namespaces
# draft-feature:
# name: Draft features
# format:
# name: Formats
plugins:
- jekyll-remote-theme
- jekyll-sitemap
aux_links:
"Latest Specification":
- "https://spec.openapis.org/oas/latest.html"
footer_content: "\xA9 2023 OpenAPI Initiative.
<br />This work is licensed under the <a rel=\"license\" href=\"https://www.apache.org/licenses/LICENSE-2.0\"\
>Apache 2.0 License</a>. This site is\
\ maintained at <a href=\"https://github.com/OAI/OpenAPI-Specification/tree/gh-pages/\">https://github.com/OAI/OpenAPI-Specification/</a>."
3 changes: 3 additions & 0 deletions _sass/color_schemes/oai.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
@import "./color_schemes/light";

$link-color: #629b34;
12 changes: 12 additions & 0 deletions _sass/custom/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
h1,h2,h3,h4,h5,h6 { color: #4E5B31; }

a[href] { color: #6BA539; }

/*.nav-list-link {
text-transform: lowercase;
}*/

/* OAI greens
6BA539
4E5B31
97D700 */
3 changes: 3 additions & 0 deletions api/alternative-schema.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
---
title: Alternative Schema API
parent: API
---
{
{% for page in site.alternative-schema %}"{{ page.slug }}": {
"slug": "{{ page.slug }}",
"title": "{{ page.title }}",
"issue": "{{ page.issue }}",
"description": "{{ page.description }}",
"url": "{{ site.baseurl }}{{ page.url }}",
"owner": "{{ page.owner }}"
}{% unless forloop.last %},{% endunless %}
{% endfor %}
Expand Down
3 changes: 3 additions & 0 deletions api/draft-feature.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
---
title: Draft Feature API
parent: API
---
{
{% for page in site.draft-feature %}"{{ page.slug }}": {
"slug": "{{ page.slug }}",
"title": "{{ page.title }}",
"issue": "{{ page.issue }}",
"description": "{{ page.description }}",
"url": "{{ site.baseurl }}{{ page.url }}",
"owner": "{{ page.owner }}"
}{% unless forloop.last %},{% endunless %}
{% endfor %}
Expand Down
2 changes: 2 additions & 0 deletions api/extension.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
parent: API
---
{
{% for page in site.extension %}"{{ page.slug }}": {
Expand All @@ -7,6 +8,7 @@
"issue": "{{ page.issue }}",
"description": "{{ page.description }}",
"owner": "{{ page.owner }}",
"url": "{{ site.baseurl }}{{ page.url }}",
"objects": {{ page.objects | jsonify }},
"schema": {{ page.schema | jsonify }}
}{% unless forloop.last %},{% endunless %}
Expand Down
3 changes: 3 additions & 0 deletions api/format.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
---
title: Format API
parent: API
---
{
{% for page in site.format %}"{{ page.slug }}": {
"slug": "{{ page.slug }}",
"title": "{{ page.title }}",
"issue": "{{ page.issue }}",
"description": "{{ page.description }}",
"url": "{{ site.baseurl }}{{ page.url }}",
"owner": "{{ page.owner }}",
"base_type": "{{ page.base_type" }}"
}{% unless forloop.last %},{% endunless %}
Expand Down
3 changes: 3 additions & 0 deletions api/namespace.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
---
title: Namespace API
parent: API
---
{
{% for page in site.namespace %}"{{ page.slug }}": {
"slug": "{{ page.slug }}",
"issue": "{{ page.issue }}",
"description": "{{ page.description }}",
"url": "{{ site.baseurl }}{{ page.url }}",
"owner": "{{ page.owner }}"
}{% unless forloop.last %},{% endunless %}
{% endfor %}
Expand Down
2 changes: 2 additions & 0 deletions api/registries.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
title: Registries API
parent: API
---
[
{% for collection in site.collections %}"{{ collection.slug }}"{% unless forloop.last %},{% endunless %}
Expand Down
26 changes: 0 additions & 26 deletions assets/css/style.scss

This file was deleted.

Binary file added favicon.ico
Binary file not shown.
3 changes: 2 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: OpenAPI Initiative gh-pages repository
title: Home
description: HTML Spec. and extensible registry
layout: default
---

# OpenAPI Initiative Registry

This site contains the OpenAPI Initiative Registry and content for the HTML versions of the OpenAPI Specification.
Expand Down
2 changes: 1 addition & 1 deletion registries/_format/byte.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ The `{{page.slug}}` format represents any sequence of octets encoded as a base64
### Remarks

{{ page.remarks }}
{% endif %}
{% endif %}
2 changes: 2 additions & 0 deletions registry/alternative-schema.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Alternative Schema Registry
layout: default
permalink: /registry/alternative-schema/index.html
parent: Registry
---

# Alternative Schema Type Registry
Expand Down
2 changes: 2 additions & 0 deletions registry/draft-feature.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Draft Feature Registry
layout: default
permalink: /registry/draft-feature/index.html
parent: Registry
---

# Draft Features Registry
Expand Down
2 changes: 2 additions & 0 deletions registry/extension.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
# title: Extensions Registry
layout: default
permalink: /registry/extension/index.html
parent: Registry
---

# Extensions Registry
Expand Down
2 changes: 2 additions & 0 deletions registry/format.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Format Registry
layout: default
permalink: /registry/format/index.html
parent: Registry
---

# Formats Registry
Expand Down
17 changes: 12 additions & 5 deletions registry/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
---
title: Registry
layout: default
permalink: /registry/index.html
has_children: true
children:
- title: Alternative Schema Registry
- title: Draft Features Registry
- title: Format Registry
- title: Namespace Registry
has_toc: false
---

## Contributing
Expand All @@ -9,14 +17,13 @@ Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls

### Contents

{% for registry in site.collections %}{% unless registry.hidden %}* <a href="./{{ registry.slug }}">{{ registry.name }}{% endunless %}
{% endfor %}
{% for registry in site.collections %}{% unless registry.hidden %}
* <a href="./{{ registry.slug }}">{{ registry.name }}{% endunless %}{% endfor %}

#### API access

* [registries.json](../api/registries.json) - Registries meta-registry
{% for registry in site.collections %}{% unless registry.hidden %}* <a href="../api/{{ registry.slug }}.json">{{ registry.slug }}.json</a>{% endunless %}
{% endfor %}
* [registries.json](../api/registries.json) - Registries meta-registry{% for registry in site.collections %}{% unless registry.hidden %}
* <a href="../api/{{ registry.slug }}.json">{{ registry.slug }}.json</a>{% endunless %} {% endfor %}

#### RSS feed

Expand Down
2 changes: 2 additions & 0 deletions registry/namespace.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Namespace Registry
layout: default
permalink: /registry/namespace/index.html
parent: Registry
---

# Namespace Registry
Expand Down

0 comments on commit 4a90c90

Please sign in to comment.