vjeantet/hugo-theme-docdock

Prepare deprecated stuff (post v0.55)

Open

#185 opened on Apr 8, 2019

View on GitHub
 (2 comments) (4 reactions) (0 assignees)JavaScript (315 forks)github user discovery
help wanted

Repository metrics

Stars
 (614 stars)
PR merge metrics
 (PR metrics pending)

Description

In the soon-to-be-released hugo v0.55 we have some WARNING about deprecated stuff :

  • .URL should be replaced by .Permalink (global, except .URL from shortcut menu obv) - see #123 too.
  • replace .Hugo.Version by site.Hugo.Version
  • replace .Hugo.Generator by site.Hugo.Generator
  • adapt attachement.html shortcode (wrap {{ with .Page.File }} around .File.BaseFileName)
+	{{ with .Page.File }}
		{{if eq .BaseFileName "_index"}}
			{{$.Scratch.Add "filesName" "files"}}
		{{else}}
			{{$.Scratch.Add "filesName" (printf "%s.files" .BaseFileName)}}
		{{end}}
+	{{ end }}

Contributor guide

Research direction
Replace deprecated Hugo template methods: .URL > .Permalink, .Hugo.Version > site.Hugo.Version, .Hugo.Generator > site.Hugo.Generator, and wrap .File.BaseFileName with {{ with .Page.File }} in attachment.html.
Tech stack
None
Domain
frontend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Hugo template knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70