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

Design/implement landing page for beta-site content stubs #342

Closed
jessicaschilling opened this issue Oct 3, 2019 · 25 comments · Fixed by ipfs/ipfs-docs#29
Closed

Design/implement landing page for beta-site content stubs #342

jessicaschilling opened this issue Oct 3, 2019 · 25 comments · Fixed by ipfs/ipfs-docs#29
Assignees
Labels
dif/medium Prior experience is likely helpful effort/weeks Estimated to take multiple weeks 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.

The new nav structure being designed for the docs beta (see #313) will result in stub pages for which content doesn't yet exist. Until it does, create and implement a common landing page to convey ...

  • The content that should be on this page doesn't exist yet, because the site is in beta
  • We'd love to work with contributors who would be interested in helping create this content sooner rather than later
  • If this missing content is crucial to you, we'd like to know
  • If you'd like to be part of collaborating on/testing/creating this content, here's how to join us (likely a link to a Google form or similar contact mechanism)
@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 beta "warning" header with collab invite Design/implement landing page for beta-site content stubs Oct 4, 2019
@ericronne
Copy link
Contributor

ericronne commented Oct 8, 2019

I'll start wiring this up. Additionally, we might be able to populate some of these pages with very-rough "starter content" — or at least simple "Click at Own Risk, There Be Demons" — pointers to third-party material, where a user might be able to find help until the content is ready to launch. I've started a hackmd doc to organize information surrounding all NEW content to be created.

NEW IPFS docs content to generate

@jessicaschilling
Copy link
Contributor Author

Thank you for linking to the related issues!

@cwaring
Copy link
Collaborator

cwaring commented Oct 8, 2019

A cute (animated) illustration will be the secret ingredient here. Diffuse disappointment with the delight of warm n' fuzzies™

@ericronne
Copy link
Contributor

Here's a somewhat high-fi draft for discussion. Let's discuss the content here, first and foremost. This doesn't represent the design, but i'm curious to hear feedback on the illustration. Time permitting, it would be fun to animate it.

no-content-here-page

@jessicaschilling
Copy link
Contributor Author

I love this so much 😄
A few thoughts?

  • Under "Other resources", I believe it's "that" rather than "which" (since not preceded by comma)
  • Under "Help us write this page", we may want to lead with something that's more explicitly community-powered: "Community contributors are invaluable to making IPFS docs great!" rather than "work with" language? We may also want to be more specific at the end: "... visit this page's GitHub issue and comment with how you'd like to get involved."
  • Maybe "Be a docs beta tester" instead of "Be a tester"?
  • In the "be a tester" content, the link can go to this form with the text "Sign up now"

More generic question and request:

  • I believe all the content here will need to be manually generated (progress "subway map" imagery, related resources, etc). Are we OK to manually support this during the transition period? (My inclination is yes, since it adds a lot of value.)
  • Re animation ... using SVG animation to move the bubbles under the pencil-ship around wouldn't be too tough. Also subtle enough to be charming without annoying.
  • Would you be amenable to making the pencil-ship pilot a little more gender-neutral?

@ericronne
Copy link
Contributor

Requests sound 👌to me … ☑️

  • No specific gender was intended, but made them more masculine.
  • The paper animation would be the tricky part. Not sure if those make sense when the rocket is in space, but we can pick up the ani Q later

no-content-here-page

@jessicaschilling
Copy link
Contributor Author

@ericronne Thanks!

@jessicaschilling
Copy link
Contributor Author

We had some input on this page as part of our IPFS Colorado user testing (see #355) and @ericronne is making some minor edits. 😊

@ericronne
Copy link
Contributor

Here's an update with rearrangements and minor copy edits. (Reminder: this doesn't reflect final page design.) Here's the illustration. Animation would be great, but for now, i think it would be more useful to prioritize other issues.

no-content-here-page

@jessicaschilling
Copy link
Contributor Author

Awesome! Going to move this one into "blocked" at the moment until we're able to actually develop on it.

@cwaring cwaring added effort/weeks Estimated to take multiple weeks dif/medium Prior experience is likely helpful and removed effort/hours Estimated to take one or several hours dif/easy Someone with a little familiarity can pick up labels Nov 4, 2019
@jessicaschilling
Copy link
Contributor Author

Update: @cwaring is implementing, but needs related items for each stub from @johnnymatthews and @jessicaschilling. These should be stored in front matter -- @cwaring, can you think about pinning the format down exactly? Something like ...

related_items:
"ProtoSchool video tutorial on a thing": https://foo.bar
"Another link title": https://link.here

@jessicaschilling
Copy link
Contributor Author

jessicaschilling commented Nov 26, 2019

@cwaring - this Google sheet should contain all the personalized info you need for each content stub:

  • Link to the GitHub issue for readers to track progress
  • 3-5 relevant links and their titles

(cc @johnnymatthews - if any content comes to mind that I've left out, please add it!)

@johnnymatthews
Copy link
Contributor

Just ran through that sheet. Nothing is glaringly wrong from my perspective, you know the content better than I do at the point. One thing we should do is mark external links with an external-links-icon.

@jessicaschilling
Copy link
Contributor Author

@johnnymatthews I believe those external links should all auto-add the external-links icon because VuePress witchery, but @cwaring can confirm?

@ericronne
Copy link
Contributor

@cwaring take with a salt grain if you've already crafted one of your characteristically brilliant solutions, but here's some visual food for thought and discussion among all. For the sake of easy implementation — and Occam's Razor-izing things — I've removed the status bar in favor of a simple text invite to follow the progress on github. …

no-content-here-page-beta-launch

Personally leaning toward the text-only approach ☝️ for the alt-resources list

@cwaring
Copy link
Collaborator

cwaring commented Nov 29, 2019

@ericronne thank you, this is great and very similar to what I had in mind :). I'm implementing the visual layout now and after experimenting with the voting options I've settled on a way to merge the functionality with the "was this helpful" widget.

@johnnymatthews
Copy link
Contributor

@ericronne
Personally leaning toward the text-only approach ☝️ for the alt-resources list.

Yeah me to. Not a fan of a bunch of icons in the copy.

@cwaring
Copy link
Collaborator

cwaring commented Dec 3, 2019

With ipfs/ipfs-docs/pull/28 merged has everything been captured to close/complete this issue?

💁‍♀️Live preview url for your convenience.

@ericronne
Copy link
Contributor

:shipit: 🚀

@jessicaschilling
Copy link
Contributor Author

Re-opening, because I need to actually implement the content for those landing page stubs.

@jessicaschilling
Copy link
Contributor Author

jessicaschilling commented Dec 3, 2019

Also, two other quick modifications from our sync call - @cwaring, are you still OK to implement these?

  • Remove "edit on GitHub" footer content from these pages only
  • Interaction logic for the "important?" buttons
  • Links for "check status" and "help with this page" (both the same destination, and driven from front matter) need to be a URL rather than a GitHub issue number, because they may refer to issues in other repos This one is fixed in Add related links to content stubs ipfs/ipfs-docs#29

@jessicaschilling
Copy link
Contributor Author

Closing this issue via ipfs/ipfs-docs#41 😊

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dif/medium Prior experience is likely helpful effort/weeks Estimated to take multiple weeks 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

Successfully merging a pull request may close this issue.

4 participants