jekyll-theme-open-project 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02245f72f837557b2a6b00defc53ec67608452f229aa836eb25d40091043015c
-  data.tar.gz: a7617a367ecbaf4d93735139615c95dacacadbfc29d1ab1d6345e93c6b3b5716
+  metadata.gz: c6366b5adfa5e11bcc91ad0e1931ad6fb7e9f35545610a2f9d37b354b7105afa
+  data.tar.gz: 0632dc0a5fb7d6c21a6c101e4f61163e4def8c42c859b4d1100b6b8ae0fcc432
 SHA512:
-  metadata.gz: bd674870e1f6bcc6735f75e2406652304c4b430007e8e490938b83d3f07645e9705b9ea51acfdaac826d0ec4d710a2d6226635d396854e37daa06697df2fa6f5
-  data.tar.gz: 6f99302a69d67bf4f1d0cd910bc6eb6f15ed09a55278c81e74774ae8ec31ce9f9622a49a09eeeadcfa2fbbdba6a4f649a2f0ecca3ca8f88fc76af058f2b0c1ae
+  metadata.gz: fac11c90495ad46f9dd266652e64239444151d368acc0aef3a89cb99ed6d78480d9de7c3968868350eb588c190f6c03bc6794bb0ca247a5e015a4c2fc7b010ea
+  data.tar.gz: cee45f97d0b8d02f19040d2ad2916af5231c8e57bdb09578ad51b81e4d703ee08b9879e09d098557c5c663dd4c451b2c16cb9400370a45b56934abc8bb5bc28e

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,26 +93,31 @@ 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.
 
-[NOTE]
-====
-It may be required to copy the following properties from
+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 may be caused by changed behavior of jekyll-data gem in recent versions,
+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
 
@@ -122,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
@@ -177,6 +197,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).
 
@@ -184,10 +206,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.
@@ -234,7 +256,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
@@ -532,7 +554,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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2021-01-10 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
@@ -240,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Open Project Jekyll theme