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

Design/implement callout links between legacy and beta pages #341

Closed
jessicaschilling opened this issue Oct 3, 2019 · 10 comments
Closed
Assignees
Labels
dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours topic/design-content Content design, writing, information architecture topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design topic/design-visual Visual design ONLY, not part of a larger UX effort

Comments

@jessicaschilling
Copy link
Contributor

jessicaschilling commented Oct 3, 2019

This issue is part of Epic 1A: Launch docs beta.

Design and implement banners or similar callouts to appear on both the legacy and beta docs sites:

  • On legacy site, invite users to view the same content on the beta site
  • On beta site, inform users that they're on a beta, with opportunities to ...
    • Return to legacy site
    • Submit feedback on beta site
    • Volunteer as a tester or otherwise more engaged user for the beta effort

Related issue is #342 (stub content landing pages).

@ericronne ericronne added topic/design-content Content design, writing, information architecture topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design topic/design-visual Visual design ONLY, not part of a larger UX effort OKR 1: Beta Launch labels Oct 3, 2019
@jessicaschilling jessicaschilling added dif/easy Someone with a little familiarity can pick up effort/hours Estimated to take one or several hours labels Oct 3, 2019
@jessicaschilling jessicaschilling changed the title Create callout invitation to docs beta Design/implement callout links between legacy and beta pages Oct 4, 2019
@jessicaschilling
Copy link
Contributor Author

@ericronne Do you want to design this one?

@ericronne
Copy link
Contributor

For sure!

@jessicaschilling
Copy link
Contributor Author

@ericronne Re the legacy site -- I think just a callout box like we've been doing with the ProtoSchool callouts would be just fine, though maybe a bright background or something - see below for reference. I can hand-code these with a link to the equivalent content on the beta site ... I might as well be the one to do it, since I know better than anyone where all that stuff lives. 😊

Suggested text: The new IPFS Docs beta is live, with easier-to-find content, search, and more! (link)Visit this page on the beta >(/link)

If you're down with this, I don't think we need any design done for the legacy site at all, just the new one.

image.png

@ericronne
Copy link
Contributor

Here's a more customized design for the legacy callout that might pay off in the number of clicks it could draw, and a simple design for the pointer linking back to the legacy site from the beta site …

Callout on legacy site

beta-pointer-for-legacy-site

Callout on beta site

This could be integrated into a footer, eg …

footer-with-legacy-pointer

@jessicaschilling
Copy link
Contributor Author

@ericronne This is awesome, thank you!
I might be inclined on the beta site to be more explicit in the text: "View this page on legacy site"?
Do you mind putting the icon for the legacy site somewhere in the legacy site repo, so I can build the callouts when we're ready? Probably here: https://github.com/ipfs/docs/tree/master/static/assets

@cwaring -- What are your thoughts on the best way to build this? Since it's one-off work, I'm happy to pick up the job of manually annotating the legacy site pages; there doesn't seem much point in templating that. For the beta site, it seems useful to template the footer callout in some way, but we'd probably need a variable in the front matter of each content .md document to specify where the equivalent page on the legacy site is? Or can you think of a better way? Thanks!

@ericronne
Copy link
Contributor

@jessicaschilling
Copy link
Contributor Author

@cwaring @ericronne -- I've implemented the legacy-site half of this in #384. Please have a look for review, but please don't merge until we are ready to launch beta. 😉

You can see it in action via CircleCI staging in the PR, but screenshot follows for reference:

image

@jessicaschilling
Copy link
Contributor Author

@cwaring The form for becoming a tester is here: https://docs.google.com/forms/d/1LVaD1B2uyW6Ff0jfU_iQ5mCeyQcHfyQO6BDD99XAgK0

@jessicaschilling
Copy link
Contributor Author

Filed ipfs/ipfs-docs#35 -- once this is approved/merged we can call this issue done (pending merge of #384 the night before launch).

@jessicaschilling
Copy link
Contributor Author

Closed via ipfs/ipfs-docs#41 😊
Please note that we will still need to merge #384 immediately prior to beta launch to fully take care of this effort — BUT as it's included in the checklist for the comms plan (see #351 (comment)), it won't get lost.

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 topic/design-content Content design, writing, information architecture topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design topic/design-visual Visual design ONLY, not part of a larger UX effort
Projects
None yet
Development

No branches or pull requests

3 participants