Move gh-pages into main branch

.github/pull_request_template.md

@@ -9,8 +9,8 @@ branch and file:
 * 3.2.0 spec: v3.2.0-dev branch, versions/3.2.0.md
 * 3.0 schema: main branch, schemas/v3.0/...
 * 3.1 schema: main branch, schemas/v3.1/...
-* registry templates: gh-pages branch, registry/...
-* registry contents: gh-pages branch, registries/...
+* registry templates: main branch, docs/registry/...
+* registry contents: main branch, docs/registries/...
 
 Note that we do not accept changes to published specifications.
 -->

.github/workflows/convert-examples-to-json.yaml

@@ -15,6 +15,8 @@ on:
   push:
     branches:
       - main
+    paths-ignore:
+      - 'docs/**'
 
 jobs:
   yaml2json:

.github/workflows/respec.yaml

@@ -5,14 +5,16 @@ name: respec
 
 #
 # This workflow updates the respec 'pretty' rendered versions of the spec 
-# on the gh-pages branch when the corresponding markdown files change.
+# on the main branch when the corresponding markdown files change.
 #
 
 # run this on push to main
 on:
   push:
     branches:
       - main
+    paths-ignore:
+      - 'docs/**'
   workflow_dispatch: {}
 
 jobs:
@@ -32,11 +34,6 @@ jobs:
     - name: Install dependencies
       run: npm ci
 
-    - uses: actions/checkout@v4 # checkout gh-pages branch
-      with:
-        ref: gh-pages
-        path: deploy
-
     - name: run main script
       run: scripts/md2html/build.sh
 
@@ -45,11 +42,10 @@ jobs:
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
         branch: update-respec-version
-        base: gh-pages
+        base: main
         delete-branch: true
-        path: deploy
         labels: Housekeeping
-        reviewers: webron,darrelmiller
+        reviewers: TSC
         title: Update ReSpec versions
         commit-message: Update ReSpec versions
         signoff: true

.github/workflows/schema-tests.yaml

@@ -10,8 +10,12 @@ name: schema-test
 
 # run this on push to any branch and creation of pull-requests
 on: 
-  push: {}
-  pull_request: {}
+  push:
+    paths-ignore:
+      - 'docs/**'
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
   workflow_dispatch: {}
 
 jobs:

.github/workflows/validate-markdown.yaml

@@ -10,11 +10,16 @@ name: validate-markdown
 #
 
 # run this on push to any branch and creation of pull-requests
-on: [push, pull_request]
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
 
 jobs:
   mdv:
-
     runs-on: ubuntu-latest
 
     steps:

.gitignore

@@ -5,6 +5,5 @@
 target
 atlassian-ide-plugin.xml
 node_modules/
-deploy/
 history
 Gemfile.lock

docs/.gitignore

@@ -0,0 +1 @@
+_site/

docs/CNAME

@@ -0,0 +1 @@
+spec.openapis.org

docs/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+## Building the site
+
+The registy site uses [jekyll](https://jekyllrb.com/), a Ruby based static site generator, with the Dinky theme.
+
+### Docker dev
+
+You can use the following Docker command to build and serve the site:
+
+```shell
+docker build . -t oas-spec/latest
+docker run -v $(pwd):/site -p 4000:4000 oas-spec/latest
+```
+
+### Local Ruby dev
+
+You will need to set up Ruby locally to run the server and see your changes.
+
+``` bash
+gem install bundler
+bundle install
+```
+
+With all the gems (dependencies) installed, you can launch the jekyll server.
+
+``` bash
+bundle exec jekyll serve
+```
+
+It will show output like this, and you can grab the Server address and open it in your browser.
+
+```
+Configuration file: /site/_config.yml
+            Source: /site
+       Destination: /site/_site
+ Incremental build: disabled. Enable with --incremental
+      Generating...
+                    done in 3.609 seconds.
+ Auto-regeneration: enabled for '/site'
+    Server address: http://0.0.0.0:4000
+```
+

docs/Dockerfile

@@ -0,0 +1,13 @@
+FROM bretfisher/jekyll-serve
+
+WORKDIR /site
+
+# install dependencies
+COPY Gemfile Gemfile.lock ./
+RUN bundle install
+
+# install the site
+COPY . .
+
+EXPOSE 4000
+CMD [ "bundle", "exec", "jekyll", "serve", "--host", "0.0.0.0" ]

docs/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.2"
+gem "webrick", "~> 1.7"
+gem "jekyll-remote-theme"
+gem "jekyll-include-cache", "~>0.2.1"
+gem "just-the-docs", "~> 0.4.2"
+
+group :jekyll_plugins do
+  gem "jekyll-sitemap", "~> 1.4"
+end

docs/Gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.2.2)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.15.5)
+    forwardable-extended (2.6.0)
+    google-protobuf (3.22.2)
+    google-protobuf (3.22.2-x64-mingw-ucrt)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.3.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (>= 0.3.6, < 0.5)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-remote-theme (0.4.3)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.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)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    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 (3.30.0)
+    rubyzip (2.3.2)
+    safe_yaml (1.0.5)
+    sass-embedded (1.58.3)
+      google-protobuf (~> 3.21)
+      rake (>= 10.0.0)
+    sass-embedded (1.58.3-x64-mingw-ucrt)
+      google-protobuf (~> 3.21)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
+
+PLATFORMS
+  ruby
+  x64-mingw-ucrt
+
+DEPENDENCIES
+  jekyll (~> 4.2)
+  jekyll-include-cache (~> 0.2.1)
+  jekyll-remote-theme
+  jekyll-sitemap (~> 1.4)
+  just-the-docs (~> 0.4.2)
+  webrick (~> 1.7)
+
+BUNDLED WITH
+   2.5.10

docs/README.md

@@ -0,0 +1,15 @@
+# OpenAPI Initiative Registry
+
+This site contains the OpenAPI Initiative Registry and content for the HTML versions of specifications managed by the OpenAPI Initiative such as the OpenAPI Specification and the Arazzo Specification.
+
+## Registry
+
+* Proceed to [Registry](./registry/index.html)
+
+## OpenAPI Initiative Specifications
+
+| Specification  | Markdown Repository | HTML Version  |
+| :--------------| :------------------ | :------- |
+| `OpenAPI Specification` | [View](https://github.com/OAI/OpenAPI-Specification)|[**Latest (3.1.0)**](oas/latest.html), [3.0.3](https://spec.openapis.org/oas/v3.0.3.html), [3.0.2](https://spec.openapis.org/oas/v3.0.2.html), [3.0.1](https://spec.openapis.org/oas/v3.0.1.html), [**3.0.0**](https://spec.openapis.org/oas/v3.0.0.html), [**2.0**](https://spec.openapis.org/oas/v2.0.html)|
+| `Arazzo Specification` | [View](https://github.com/OAI/Arazzo-Specification) | [1.0.0](https://spec.openapis.org/arazzo/v1.0.0.html)|
+

docs/_config.yml

@@ -0,0 +1,68 @@
+# 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
+collections:
+  posts:
+    hidden: true
+  object:
+    slug: object
+    name: Object Registry
+    hidden: true
+  format:
+    slug: format
+    name: Format Registry
+    output: true
+    permalink: /registry/:collection/:title
+  extension:
+    slug: extension
+    name: Specification Extension Registry
+    output: true
+    permalink: /registry/:collection/:title
+  draft-feature:
+    slug: draft-feature
+    name: Draft Features Registry
+    output: true
+    permalink: /registry/:collection/:title
+  alternative-schema:
+    slug: alternative-schema
+    name: Alternative Schema Type Registry
+    output: true
+    permalink: /registry/:collection/:title
+  namespace:
+    slug: namespace
+    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 OpenAPI Specification":
+    - "https://spec.openapis.org/oas/latest.html"
+  "Latest Arazzo Specification":
+    - "https://spec.openapis.org/arazzo/latest.html"
+footer_content: "\xA9 2024 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/main/docs/\">https://github.com/OAI/OpenAPI-Specification/</a>."

docs/_includes/alternative-schema-entry.md

@@ -0,0 +1,11 @@
+# <a href="..">{{ page.collection }}</a>
+
+## {{ page.slug }} - {{ page.description }}
+
+{{ include.summary }}
+
+{% if page.issue %}
+### GitHub Issue
+
+* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
+{% endif %}

docs/_includes/extension-entry.md

@@ -0,0 +1,16 @@
+# <a href="..">{{ page.collection }}</a>
+
+## {{ page.slug }} - {{ page.description }}
+
+{{ include.summary }}
+
+### Schema
+
+```yaml
+{{page.schema}}
+```
+
+### Example
+
+{{ include.example }}
+