Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

Reshuffle the Guides docs landing page to match the section contents #262

Closed
ericronne opened this issue Aug 30, 2019 · 2 comments · Fixed by #360
Closed

Reshuffle the Guides docs landing page to match the section contents #262

ericronne opened this issue Aug 30, 2019 · 2 comments · Fixed by #360
Assignees
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours help wanted Seeking public contribution on this issue topic/docs Documentation

Comments

@ericronne
Copy link
Contributor

ericronne commented Aug 30, 2019

This issue is part of Epic 3B: Fixes from legacy issue queue.

"Install" is noted twice on the Guides index page, and neither summary is a good intro to the section to which it links. Remedy.

@ericronne ericronne self-assigned this Aug 30, 2019
@jessicaschilling jessicaschilling added dif/easy Someone with a little familiarity can pick up help wanted Seeking public contribution on this issue labels Aug 30, 2019
@jessicaschilling
Copy link
Contributor

This is a little more complex than it looks at first, because it involves Hugo's auto-generated landing pages - just FYI.

@jessicaschilling jessicaschilling added the effort/hours Estimated to take one or several hours label Sep 19, 2019
@jessicaschilling jessicaschilling changed the title Hotfix: Reshuffle the Guides docs landing page to match the section contents Reshuffle the Guides docs landing page to match the section contents Sep 19, 2019
@jessicaschilling jessicaschilling added topic/docs Documentation and removed Q319: Hotfixes labels Sep 26, 2019
@jessicaschilling
Copy link
Contributor

See below for screenshot of a compromise solution -- since we're leaving Hugo behind with deployment of the docs beta, it didn't seem a good use of time to dig into its means of auto-generating content on page bundle index pages.

What this does:

  • Removes duplicate content
  • Fixes typos and poor wording in original top-of-page text about install page
  • Adds a prominent visual callout (in existing design language) at the top of the page leading to the install guide

What this doesn't do:

  • Hide the poorly-formatted, auto-generated Hugo content at the bottom of the page for "install IPFS" or "addressing in browsers"

@ericronne, I'm taking the liberty of closing this issue, but please reach out if you want to iterate on it more! Thanks.

image

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours help wanted Seeking public contribution on this issue topic/docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants