jekyll-theme-open-project 2.1.3 → 2.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4801099a04b30000dd3740fcddab2a0d0fba94c02246c805ac13ecb082fbdc55
-  data.tar.gz: 401c8baa1493dd2fc9f7b00c019d1cb30f634eca4e361da1cc306908ac479d90
+  metadata.gz: af63c02fa907c304d3594a92b48ae9ce752f1f44108adc381b0e4cee059796cb
+  data.tar.gz: 63aa8c97a61c5e4c3483117efab190d12c8040e474154b683b10c050af687ba5
 SHA512:
-  metadata.gz: 8fa7d7242a05f8f39805b090df6c8004d443b542b3ecc7dc6e0875d0d4843e1356dc53d9c6313a652a52c9c58a1f37ea1531450824e677a2255284c1af1e1e83
-  data.tar.gz: 979268f2ed79c6aa9ff4836706900579107a9d3ff487bc7463e137b56628333e4f036a70b42ae3976a37778d12ca0d8136ab1fccb3a9046df5143adf65ea3bb9
+  metadata.gz: 8e12e33e27c27e12b78ee8396810bcd4c92dcd5f64ae3c900addee87e8fe27d0ac021444efa8859ff6267a319ae8f2099823d20ca59477602af38b1fde7d483e
+  data.tar.gz: c60b019179c6ba95c7857b336567df691361271031badda95ee12493d192723ea922d11c98e27770580a996cb5e96cf7f2e59e4ce53c628b814a95afe59314a1

data/README.md

@@ -5,9 +5,11 @@ aiming to help organizations and individuals present
 open-source software and specifications in a navigable and elegant way.
 
 Open Project fits two types of sites:
-that describe one individual project, and that combine projects into sort of an open hub.
 
-**Demo**: See [Ribose Open](https://open.ribose.com/) project sites—for example,
+* a site that describes one individual project
+* a site that combine projects into sort of an open hub.
+
+**Demo**: See [Ribose Open](https://open.ribose.com/) project sites -- for example,
 [Metanorma](https://www.metanorma.com),
 [RNP](https://www.rnpgp.com),
 [Cryptode](https://www.cryptode.com),
@@ -38,9 +40,9 @@ to AWS S3.
   * [Includes](#theme-includes)
 
 
-## Starting a site with this theme
+## Getting started
 
-### Getting started with Ruby and Jekyll
+### Set up Ruby and Jekyll
 
 The currently recommended Ruby version is 2.6.
 (In case you aren’t using Ruby often, the easiest way to install one may be with RVM.)
@@ -48,10 +50,10 @@ The currently recommended Ruby version is 2.6.
 The currently recommended Jekyll version is 3 or newer
 (read about [Jekyll installation](https://jekyllrb.com/docs/#instructions)).
 
-Note: this theme is known to not work with Ruby older than 2.3,
+NOTE: this theme is known to not work with Ruby older than 2.3,
 and hasn’t been tested on newer versions.
 
-### Start new Jekyll site
+### Start a new Jekyll site
 
     jekyll new my-open-site
 
@@ -59,7 +61,7 @@ If you use Git for site source version management,
 see the “Extra .gitignore rules” section below
 for additional lines you should add to your `.gitignore`.
 
-### Installing theme
+### Install Open Site theme into the Jekyll site
 
 Add this line to your Jekyll site's `Gemfile`,
 replacing default theme requirement:
@@ -91,15 +93,32 @@ Execute the following to install dependencies:
 
     $ bundle
 
-### Configuring site
+### Configure your Open Site for the first time
 
-Edit _config.yml to add necessary site-wide configuration options,
+Edit `_config.yml` to add necessary site-wide configuration options,
 and add files and folders to site contents. This step depends
 on the type of site you’re creating: hub or individual project site.
 
 Further sections explain core concepts of open project and hub, and go
 into detail about how to configure a project or hub site.
 
+Before building the first time you must do this:
+
+1. Configure [common settings](#common-settings)
+2. Add your logo(s) according to [logo](#logo)
+
+Please see the [configuration section](#configuration) for more details.
+
+NOTE: It may be required to copy the following properties from
+this theme’s `_config.yaml` to your site’s: `collections`, `includes_dir`.
+
+This is likely caused by changed behavior of jekyll-data gem in recent versions,
+which is responsible for “inheritance” of `_config.yaml` between theme and site.
+
+You can add any custom collections for your site
+after collections copied from theme’s config.
+
+
 ### Building site
 
 Execute to build the site locally and watch for changes:
@@ -110,17 +129,30 @@ This assumes you have mysite.local mapped in your hosts file,
 otherwise omit --host and it’ll use “localhost” as domain name.
 
 
-## General setup
+## Configuration
+
+There are 3 areas to configure when you first create an Open Site, namely:
+
+* [Common setup](#common-setup), settings that apply to both Hub and Project sites;
+* [Hub site](#hub-site);
+* [Project site](#project-site)
+
+
+## Common setup
+
+### Common settings
+
+(mandatory)
 
 These settings apply to both site types (hub and project).
 
-- You may want to remove the default about.md page added by Jekyll,
+- You may want to remove the default `about.md` page added by Jekyll,
   as this theme does not account for its existence.
 
 - Add `hero_include: home-hero.html` to YAML frontmatter
   in your main `index.md`.
 
-- Add following items to site’s _config.yml
+- Add following items to site’s `_config.yml`
   (and don’t forget to remove default theme requirement there):
 
   ```yaml
@@ -133,12 +165,21 @@ These settings apply to both site types (hub and project).
   # URL to GitHub repo for the site.
   # Using GitHub & specifying this setting is currently required
   # for “suggest edits” buttons to show on documentation pages.
+  github_repo_branch: main
+  # Optional, default is `main`.
 
   title: Example
   description: The example of examples
   # The above two are used by jekyll-seo-tag for things such as
   # `<title>` and `<meta>` tags, as well as elsewhere by the theme.
 
+  default_repo_branch: main
+  # Optional, default is `main`.
+  # Whenever a branch name isn’t specified for some repository
+  # (such as project docs or specs), this name will be used.
+  # For configuration options that contain repository settings,
+  # search `git_repo_branch`, `repo_branch`, `github_repo_branch`.
+
   tagline: Because examples are very important
   # Used in hero unit on main page.
 
@@ -165,6 +206,8 @@ These settings apply to both site types (hub and project).
 
 ### Logo
 
+(mandatory)
+
 By “logo” is meant the combination of site symbol as a graphic
 and name as word(s).
 
@@ -172,10 +215,10 @@ and name as word(s).
   Should look OK in dimensions of 30x30px, and fit inside a square.
   Should be in SVG format (see also the SVG guidelines section).
 
-  - Drop your site-wide symbol in <site root>/assets/symbol.svg.
+  - Provide your site-wide symbol in <site root>/assets/symbol.svg.
 
-  - Drop PNG renders of the symbol as favicon.png and favicon-192x192.png
-    under <site root>/assets/; use transparent background.
+  - Provide the symbol as PNG renders as `favicon.png` and `favicon-192x192.png`
+    under `<site root>/assets/`; use transparent background.
 
 - **Site name** displayed to the right of the symbol.
   Limit the name to 1-3 words.
@@ -222,7 +265,7 @@ hero_include: index-page-hero.html
 In general, posts are authored as per usual Jekyll setup.
 
 It is recommended that you provide explicit hand-crafted post excerpts,
-as automatically-generated excerpts may break post card markup.
+as automatically-generated excerpts may break the post card layout.
 
 Theme also anticipates author information within frontmatter.
 Together with excerpts, here’s how post frontmatter (in addition to anything
@@ -299,6 +342,7 @@ featured: true | false
 
 site:
   git_repo_url: <Git URL to standalone project site source repo>
+  git_repo_branch: <branch name in the above repo>
 
 home_url: <URL to standalone project site>
 
@@ -376,6 +420,7 @@ author: "Company or Individual Name Goes Here"
 # reference the hub.
 parent_hub:
   git_repo_url: git@example.com:path/to-repo.git
+  git_repo_branch: somebranchname
   home_url: https://www.example.com/
 
 algolia_search:
@@ -520,7 +565,7 @@ description: A sentence.
 # but used for HTML metadata if jekyll-seo-tag is enabled
 
 tags: [Ruby, Python, RFC, "<some_namespace_id>:<appropriate_tag>"]
-# Note: Avoid whitespaces and other characters that may make Jekyll
+# NOTE: Avoid whitespaces and other characters that may make Jekyll
 # percent-encode the tag in URLs. Replace " " (a regular space)
 # with "_" (underline); underlines will be rewritten as spaces when tags
 # are presented to site users.
@@ -566,9 +611,12 @@ repo_url: https://github.com/riboseinc/asciidoctor-rfc
 # Used for things like showing how long ago
 # the was project updated last.
 
+repo_branch: main
+
 docs_source:
   git_repo_url: git@example.com:path/to-repo.git
   git_repo_subtree: docs
+  git_repo_branch: main
 # Documentation, the contents of which will be made part of the project site.
 # See the nearby section about documentation.
 ```
@@ -610,6 +658,7 @@ YAML frontmatter specific to specs:
 spec_source:
   git_repo_url: https://github.com/<user>/<repo>
   git_repo_subtree: images
+  git_repo_branch: main
   build:
     engine: png_diagrams
 # See below about building the spec from its source

data/_includes/item-doc-page.html

@@ -103,7 +103,7 @@ supporting expandable navigation widget.
 
           {% assign suggest_edits_base_url = item_data.docs.git_repo_url | default: item_data.repo_url %}
           {% if suggest_edits_base_url %}
-            <a href="{{ suggest_edits_base_url }}/edit/master/{{ item_data.docs.git_repo_subtree | default: "docs" }}/{{ page.path | split: "/" | last }}" class="docs-suggest-edits">Suggest edits to this page</a>
+            <a href="{{ suggest_edits_base_url }}/edit/{{ item_data.docs.git_repo_branch | default: site.default_repo_branch | default: 'main' }} /{{ item_data.docs.git_repo_subtree | default: "docs" }}/{{ page.path | split: "/" | last }}" class="docs-suggest-edits">Suggest edits to this page</a>
           {% endif %}
         </nav>
       {% endif %}

data/_includes/legal.html

@@ -1,5 +1,5 @@
 <span class="copyright">
-  <span class="copyright-head">Copyright © {{ site.time | date: '%y' }} {{ site.legal.name }} —</span>
+  <span class="copyright-head">Copyright © {{ site.time | date: '%Y' }} {{ site.legal.name }} —</span>
   <span class="copyright-tail">All rights reserved.</span>
 </span>
 

data/_layouts/docs-base.html

@@ -54,7 +54,7 @@ layout: default
           {% endif %}
 
           {% if site.github_repo_url %}
-            <a href="{{ site.github_repo_url }}/edit/master/{{ page.path }}" class="docs-suggest-edits">Suggest edits to this page</a>
+            <a href="{{ site.github_repo_url }}/edit/{{ item_data.docs.github_repo_branch | default: site.default_repo_branch | default: 'main' }}/{{ page.path }}" class="docs-suggest-edits">Suggest edits to this page</a>
           {% endif %}
         </nav>
       {% endif %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.1.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.1.1
 - !ruby/object:Gem::Dependency
   name: jekyll-seo-tag
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 2.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 2.1.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement