Skip to content
This repository has been archived by the owner on Apr 22, 2021. It is now read-only.

Adds cover image (and other small things) #63

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Loquacity
Copy link
Member

@Loquacity Loquacity commented Nov 29, 2020

ALL Pull-Requests require an associated Issue as documented in How to contribute.

Fixes: thegooddocsproject/templates#173

Purpose / why

Adds an image to the cover of the interactive IA Guide

What changes were made?

  • Adds .svg and .png images to the images directory, and links it to the cover page of the interactive IA Guide.
  • Slight modifications to the GH Action to make it run effectively when a PR is created from a fork.
  • Adds a short note to the twine file for future contributors.

Verification

  • Check that the image is appropriate
  • Check that the image appears correctly.
  • Ensure checks have passed

Checklist

Pull-request reviewer should ensure the following

  • Are issues linked correctly?
  • Is this PR labeled correctly?
  • If template updates: do they align with developers.google.com/style/?
  • Did the PR receive at least one 👍 and no 👎 from core-maintainers?
  • On merging, did you complete the merge using keywords?
  • On merging, did you add any applicable notes to a draft release and link to this PR?

@Loquacity
Copy link
Member Author

@mgan59 I think the action won't run because I've proposed from a fork, rather than a direct branch. Can we adjust the action so that works, or is this a limitation of GH Actions?

@Loquacity
Copy link
Member Author

@mgan59 I think the action won't run because I've proposed from a fork, rather than a direct branch. Can we adjust the action so that works, or is this a limitation of GH Actions?

I might have answered my own question. According to https://github.blog/2020-08-03-github-actions-improvements-for-fork-and-pull-request-workflows/ I need to change the action to run on: [pull_request_target]. Let me try that.

@Loquacity Loquacity changed the title Adds cover image Adds cover image (and other small things) Nov 29, 2020
@Loquacity Loquacity requested a review from camerons March 1, 2021 04:06
Copy link
Member

@camerons camerons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I've taken so long to review this, that this website repo has become deprecated, replaced by the hugo-website repo.

Lana, if there is anything of value in this pull request, I suggest that you re-apply it to the hugo-website repo.

Sorry for the slow review, and resulting extra work caused. I'll commit to review within a couple of weeks if you redo this in the hugo repo (and tell me of it).

I'll leave it to you Lana to decide whether you want this review approved here as well, but I'd suggest this request should be closed out with no action.

@Loquacity
Copy link
Member Author

I don't have the time to handle this right now, sorry. Feel free to close it. If someone wants to take these images and add them to the new site, I'm happy for them to do so.

@camerons camerons added the good first issue Good for newcomers label Mar 29, 2021
@camerons
Copy link
Member

camerons commented Mar 29, 2021

This is a good first time issue for someone who wants to learn how to use git.
Look at these changes that Loquacity has recommended in this legacy repository thegooddocsproject.github.io and copy the changes across to https://github.com/thegooddocsproject/website-hugo

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

IA Guide - Add cover image
2 participants