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

Create an 'include' for displaying links to Github wiki docs #370

Open
afred opened this issue Oct 30, 2018 · 0 comments
Open

Create an 'include' for displaying links to Github wiki docs #370

afred opened this issue Oct 30, 2018 · 0 comments
Labels

Comments

@afred
Copy link
Contributor

afred commented Oct 30, 2018

Rationale: during Docs WG breakout as Samvera Connect 2018, we discussed ways to better expose links to other documentation, in particular Github Wiki pages.

Not sure if there is already an "external links" feature in the current theme, so that's something to check.

If it exists, then let's explore it.

If it doesn't, then a reasonable way to go about this would be to...

  1. create a template at _includes/external_links.html
  2. The template uniformly calls out a set of links (most likely at the bottom of the page content)
    1. each link has a URL, a title, and target="_blank".
  3. links are specified per-page in the front matter, with a clearly understood key that matches the template name, e.g...
    external_links:
      - url: "https://github.com/samvera/hyrax/wiki/Feature-matrix"
         title: "Hyrax Feature Matrix"
      - url: "https://github.com/samvera-labs/valkyrie/wiki"
         title: "Valkyrie Documentation"
    

Done when:

  1. content editors can easily, and uniformly, add links to other documentation to each page via front matter.
  2. Used in at least 1 page so approvers can see it working
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant