Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor shortguides #1996

Merged
merged 7 commits into from
Aug 24, 2018
Merged

Refactor shortguides #1996

merged 7 commits into from
Aug 24, 2018

Conversation

nmelehan
Copy link
Contributor

@nmelehan nmelehan commented Aug 23, 2018

This moves all shortguides that didn't use leaf bundles (e.g. my-shortguide.md) into leaf bundles (e.g. my-shortguide/index.md).

Also changes all shortguide yaml used (i.e. shortguide: true) to use headless instead (i.e. headless: true). headless works a bit different from shortguide: it not only suppresses the guide from the index and the search index, it also prevents the guide from rendering on its own at all (i.e. unless embedded in another guide), so it can't be directly linked to.

Two scripts were used to do this:

  1. Convert shortguides to leaf bundles
  2. Rename shortguide to headless

This PR also updates the shortguide archetype and the Linode Writer's Guide to show how to use leaf bundles and the headless yaml for shortguides.

A large number of files were changed in this PR. The changes were verified as successful by:

  1. Spot-checking that headless guides do not render on their own/are not directly linkable and do not appear in indexes or the search index.
  2. Spot-checking that headless guides embed normally.
  3. Verifying that the 'Content shortcode is empty' message does not appear when building Hugo locally, which is an error message given by the content shortcode.

@Guaris Guaris merged commit 94a49a2 into linode:master Aug 24, 2018
@GuessWhoSamFoo
Copy link
Contributor

Why bother with bundles at all if the path is abstracted away?

Hiding from RSS feed should be part of being headless

Limited user note has too much complexity for what can be a shortcode

@Guaris

@nmelehan
Copy link
Contributor Author

headless won't work on non-bundled guides, and bundles allow us to bundle images in shortguides as we would for any other guide.

We're renaming shortguide to hiddenguide and repurposing it for some other guides that we do want to render and be directly linkable.

I thought that headless by itself should hide a guide from RSS, but I'll check on that.

I prefer having another shortguide to having another shortcode (for limited user note), but maybe other members of the team disagree

@nmelehan
Copy link
Contributor Author

nmelehan commented Aug 28, 2018

Hi @GuessWhoSamFoo

Here's what I've found about why headless should suppress a guide from the RSS feed without needing show_on_rss_feed also set to false:

Can I ask if you've seen any shortguides in the RSS feed since this PR? I haven't seen any myself

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants