From 23bbef879187ba610deae0847faa8d546a354122 Mon Sep 17 00:00:00 2001 From: Matt Stratton Date: Tue, 1 Dec 2020 13:02:10 -0600 Subject: Misc fixes (#308) --- CONTRIBUTING.md | 56 ++++++++++++++++++++----------------- README.md | 10 +++++-- exampleSite/config.toml | 2 +- layouts/partials/head.html | 10 +++---- layouts/partials/head_includes.html | 5 ++++ layouts/partials/seo.html | 11 +------- 6 files changed, 49 insertions(+), 45 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f9bbdf..5dd61ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,38 +3,38 @@ The technical details on how to set up your local development environment for making changes to the `castanet` [Hugo](https://gohugo.io/) theme for podcasts. # Table of contents - + - [Set up your environment](#set-up-your-environment) - - [Git remote setup](#git-remote-setup) - - [Installing dependencies](#installing-dependencies) - - [Install Node.js and npm](#install-nodejs-and-npm) - - [Install gulp](#install-gulp) - - [Install node modules](#install-node-modules) + - [Git remote setup](#git-remote-setup) + - [Installing dependencies](#installing-dependencies) + - [Install Node.js and npm](#install-nodejs-and-npm) + - [Install gulp](#install-gulp) + - [Install node modules](#install-node-modules) - [How can I help?](#how-can-i-help) - [Making changes](#making-changes) - - [Testing changes](#testing-changes) - - [Create a commit](#create-a-commit) - - [Branching and Pull Requests](#branching-and-pull-requests) + - [Testing changes](#testing-changes) + - [Create a commit](#create-a-commit) + - [Branching and Pull Requests](#branching-and-pull-requests) - [Design Principles](#design-principles) - - [Frameworks](#frameworks) - - [Blocks](#blocks) - - [CSS and SCSS](#css-and-scss) - - [`site.scss`](#sitescss) - - [`color-variables.scss`](#color-variablesscss) - - [`custom.scss`](#customscss) - - [Javascript](#javascript) + - [Frameworks](#frameworks) + - [Blocks](#blocks) + - [CSS and SCSS](#css-and-scss) + - [`site.scss`](#sitescss) + - [`color-variables.scss`](#color-variablesscss) + - [`custom.scss`](#customscss) + - [Javascript](#javascript) - [Local build and testing](#local-build-and-testing) - - [Build new javascript and stylesheets](#build-new-javascript-and-stylesheets) + - [Build new javascript and stylesheets](#build-new-javascript-and-stylesheets) - [Continuous Integration](#continuous-integration) - - [Issues](#issues) - - [GitHub Labels](#github-labels) - - [Pull Requests](#pull-requests) + - [Issues](#issues) + - [GitHub Labels](#github-labels) + - [Pull Requests](#pull-requests) - [Documentation](#documentation) - [Releasing](#releasing) - [Creating a new color theme](#creating-a-new-color-theme) - [Developer Certification of Origin (DCO)](#developer-certification-of-origin-dco) - - [DCO Sign-Off Methods](#dco-sign-off-methods) + - [DCO Sign-Off Methods](#dco-sign-off-methods) @@ -45,7 +45,7 @@ Prerequisites: * `make` (note - this is not needed yet) * `gulp` v4.0.0+ * `nodejs` and `npm` -* [hugo v0.58.3+](https://gohugo.io) +* [hugo v0.69.2+](https://gohugo.io) Clone `castanet` from source into your working directory of choice: @@ -104,7 +104,7 @@ Sort the existing GitHub issues for the tag of `help-wanted`. These are issues t ### Testing changes -TODO: Write the test instructions +There are no automated tests, but it is recommended that you test manually by testing both `row` and `grid` configurations in the `config.toml` inside `exampleSite`. ### Create a commit @@ -151,7 +151,7 @@ $ git reset --hard upstream/master ### Frameworks -We use [Boostrap v4 Alpha](http://v4-alpha.getbootstrap.com/) as our basic framework. +We use [Boostrap v4](https://getbootstrap.com/) as our basic framework. ### Blocks All page templates should make use of the `layouts/_default/baseof.html` file. This file contains all wrappers for the content. Anything within the `{{- block "main" . }} {{- end -}}` section is what will be displayed on a sub-template. Include a `{{ define "main" }}` block in your template to include what should be rendered. @@ -182,7 +182,9 @@ Inside the theme directory, run `npm install`. Run `gulp dev` to build the compiled stylesheets and Javascript files ## Continuous Integration -The `castanet` repo has hooks into Travis, Appveyor, and Netlify. Currently, the Travis build doesn’t do very much (the intent is to add some testing using Casper.js for web testing, but no tests have been written). The Appveyor tests ensure that the site can build with Windows. +The `castanet` repo has hooks into CircleCI and Netlify. The CircleCI builds the site according the various configurations (row vs grid and with all the color schemes). If you're curious, you can check out the CircleCI configuration in [.circleci/config.yml](https://github.com/mattstratton/castanet/blob/master/.circleci/config.yml). + +We use the Deploy Previews feature of Netlify. The config for this is at [netlify.toml](https://github.com/mattstratton/castanet/blob/master/netlify.toml). All changes are built by Netlify to http://sample-castanet.netlify.com/ once merged to master. @@ -196,6 +198,8 @@ All changes should be driven by issues (this is because our changelog generator Only repository contributors can add tags to issues; if you do not have permission to tag an issue, please prepend the title with `[BUG]` or `[ENHANCEMENT]` as appropriate. +If you use the issue templates when opening your issues, the proper titles and tags should be added for you! + ### GitHub Labels These are the labels we use, and what they mean: @@ -212,7 +216,7 @@ These are the labels we use, and what they mean: ### Pull Requests -Please submit your proposed changes as a Pull Request against this repository. If the PR will resolve an issue, please add `Fixes #123` to the PR. We also will label issues as `bug` or `enhancement` for proper CHANGELOG generation. +Please submit your proposed changes as a Pull Request against this repository. If the PR will resolve an issue, please add `Fixes #123` to the PR. We also will label issues as `bug` or `enhancement` for proper CHANGELOG generation. For more details, see [Linking a pull request to an issue using a keyword](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). ## Documentation diff --git a/README.md b/README.md index 3a4b976..bc1773f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -[![Build Status](https://travis-ci.org/mattstratton/castanet.svg?branch=master)](https://travis-ci.org/mattstratton/castanet) +[![mattstratton](https://circleci.com/gh/mattstratton/castanet.svg?style=shield)](https://circleci.com/gh/mattstratton/castanet) [![GitHub release](https://img.shields.io/github/release/mattstratton/castanet.svg)](https://github.com/mattstratton/castanet/releases) -[![Github All Releases](https://img.shields.io/github/downloads/mattstratton/castanet/total.svg)]() -[![license](https://img.shields.io/github/license/mattstratton/castanet.svg)]() +[![Github All Releases](https://img.shields.io/github/downloads/mattstratton/castanet/total.svg)](https://github.com/mattstratton/castanet/releases) +[![license](https://img.shields.io/github/license/mattstratton/castanet.svg)](https://github.com/mattstratton/castanet/blob/master/LICENSE) +[![contributing](https://img.shields.io/badge/contributing-info-informational)](https://github.com/mattstratton/castanet/blob/master/CONTRIBUTING.md) If you would like to receive emails when new versions of this theme are released, [subscribe to the announcement email list](http://eepurl.com/cMAJcL). @@ -27,6 +28,9 @@ After installing Castanet successfully it requires a just a few more steps to ge See [REFERENCE.md](https://github.com/mattstratton/castanet/blob/master/REFERENCE.md) for all configuration file settings as well as instructions on episodes, guests, hosts, and sponsors +## Contributing to castanet +If you would like to help make improvements or fixes to this theme, please see [CONTRIBUTING.md](https://github.com/mattstratton/castanet/blob/master/CONTRIBUTING.md) for detailed instructions. + ## Sites using the Castanet theme This is a completely non-comprehensive list of podcasts that use this theme. Want to add your site? Submit a pull request against the README file! - [Arrested DevOps](https://www.arresteddevops.com) diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 3fd8a1d..2ff5330 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -80,7 +80,7 @@ stitcher_subscribe = "http://www.stitcher.com/podcast/arrested-devops-2/arrested soundcloud_subscribe = "http://feeds.soundcloud.com/users/soundcloud:users:203144248/sounds.rss" pocketcasts_subscribe = "http://pcasts.in/feed/feeds.soundcloud.com/users/soundcloud:users:203144248/sounds.rss" mailchimp_subscribe = "//arresteddevops.us3.list-manage.com/subscribe/post?u=5e4cbcac996bb9df25f970a89&id=154fa76bcc" -#rss_subscribe = "http://feed.com/myfeed" #only set this if you don't want to use the built-in feed +# rss_subscribe = "http://feed.com/myfeed" #only set this if you don't want to use the built-in feed description = "The HugoCast is the best podcast you've ever seen. You will learn everything you ever needed to know about [podcasting](https://en.wikipedia.org/wiki/Podcast) from the most inspiring experts to ever show up on the whole internet." media_prefix = "https://media.blubrry.com/arresteddevops/content.blubrry.com/arresteddevops/" disqusShortname = "" diff --git a/layouts/partials/head.html b/layouts/partials/head.html index 3d5bd30..69a5054 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -1,12 +1,12 @@ {{ partial "meta.html" . }} {{ partial "seo.html" . }} -{{ $url := replace .Permalink ( printf "%s" .Site.BaseURL) "" }} -{{ if eq $url "/" }} +{{- $url := replace .Permalink ( printf "%s" .Site.BaseURL) "" -}} +{{- if eq $url "/" -}} {{ .Site.Title }} -{{ else }} - {{ if .Params.Heading }} {{ .Params.Heading }} {{ else }} {{ .Title }} {{ end }} -{{ end }} +{{- else -}} + {{ if .Params.Heading }}{{ .Params.Heading }}{{ else }}{{ .Title }}{{ end }} +{{- end -}} {{ partial "head_includes.html" . }} diff --git a/layouts/partials/head_includes.html b/layouts/partials/head_includes.html index ec394f8..2812f1e 100644 --- a/layouts/partials/head_includes.html +++ b/layouts/partials/head_includes.html @@ -48,3 +48,8 @@ } +{{- if (isset $.Site.Params "rss_subscribe" ) -}} + +{{- else -}} + +{{- end -}} diff --git a/layouts/partials/seo.html b/layouts/partials/seo.html index 9b9a0e7..c2bc187 100644 --- a/layouts/partials/seo.html +++ b/layouts/partials/seo.html @@ -4,12 +4,8 @@ - -{{- with .Site.Params.title -}}{{- end -}} +{{- with .Site.Title -}}{{- end -}} {{- with .Params.locale -}}{{- end -}} - - - {{- if .IsHome -}} {{ with .Site.Params.feed.itunes_summary -}} @@ -25,7 +21,6 @@ {{- end -}} - {{ with .Site.Params.social.twitter }}{{ end }} {{ with .Site.Params.social.twitter }}{{ end }} {{ with .Site.Params.social.twitter_domain }}{{ end }} @@ -37,7 +32,6 @@ {{ end }} - {{ with .Params.images }}{{ range first 1 . }} {{ if (eq (slicestr . 0 4) "http") }} @@ -50,9 +44,6 @@ {{ end }} {{ end }}{{ end }} - - - {{ with .Site.Params.social.facebook_admin }} {{ range . }} -- cgit v1.2.3