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

Doc Site: Creating the documentation landing page integrated with Overture.bio #50

Closed
2 tasks
gokul472 opened this issue Jul 31, 2020 · 12 comments
Closed
2 tasks
Assignees
Labels
canarie SP:3 Issue is estimated at 3 story points

Comments

@gokul472
Copy link

gokul472 commented Jul 31, 2020

This ticket is for the Documentation landing page.

  • The documentation page will be created and integrated with the Overture.bio website.

  • This page will have the dedicated sections for the search banner, DMS Installation instructions link, Help by topic links and product documentation callouts.

Note: the menu and footer changes are noted in this ticket: #46

ZEPLIN link https://zpl.io/bLMOvyD
2020-08-10_12-10-58

@gokul472 gokul472 added this to the [FUTURE] Canarie - Sprint 3 milestone Aug 6, 2020
@gokul472 gokul472 added the SP:3 Issue is estimated at 3 story points label Aug 6, 2020
@gokul472 gokul472 assigned samrichca and unassigned anncatton Aug 20, 2020
@gokul472 gokul472 changed the title Creating the documentation landing page integrated with Overture.bio Doc Site: Creating the documentation landing page integrated with Overture.bio Aug 20, 2020
@samrichca samrichca removed their assignment Sep 16, 2020
@b-f-chan b-f-chan removed this from the Canarie Sprint 8 milestone Oct 16, 2020
@b-f-chan b-f-chan added this to the Canarie Sprint 8 milestone Oct 28, 2020
@samrichca
Copy link
Member

@samrichca
Copy link
Member

WITH DOCS:

https://5f9acfe116493e00852858a6--overture.netlify.app/documentation

NO DOCS:

I need other tickets to be merged first (markdown POC)

@b-f-chan
Copy link

Testing will carryover to Sprint 9 (cc: @kcullion @rosibaj you may want to have a look also)

@kcullion
Copy link

thanks @b-f-chan I will have a closer look tomorrow, but it's looking great @samrichca

One thing I did notice, before I forget, is the active state is missing from the menu for the Documentation item
image

@samrichca
Copy link
Member

@kcullion yup! it's in the nav highlight ticket

@kcullion
Copy link

kcullion commented Oct 29, 2020

yay! thanks @samrichca
can you tell I hate being lost haha

@samrichca
Copy link
Member

wayfinding is important!!

@kcullion
Copy link

kcullion commented Oct 30, 2020

@b-f-chan @samrichca this looks great to me...just found a couple small things, and one is just a wording change.
(Sam, love your use of proper h1, h2, h3 tags!!)
2020-10-30_10-42-56.png

@samrichca
Copy link
Member

samrichca commented Nov 2, 2020

@kcullion i can't take the credit, that's fancy markdown processing for ya!

  • docs header height will change when search is added
  • updated chevron link... safari weirdness
  • text update in oncojs card

https://5fa038750a252d00ee9247c6--overture.netlify.app/documentation

@kcullion
Copy link

kcullion commented Nov 2, 2020

Looks good @samrichca thanks. Even with the search is added - this area can be shorter. But you'll get to that with the search I'm sure :)

@b-f-chan
Copy link

b-f-chan commented Nov 3, 2020

Tested at latest netlify link:

  • Following are correctly placed and present as in the Zeplin:
    • Header logo, links to Slack & GitHub
    • Nav menu items
    • Footer categories, copyright & links
    • DMS Intro section, Help by Topic section
    • Product Documentation section (all required products are listed with correct descriptions)
    • All links go to the correct page, except those where content not complete yet
    • Wording change in OncoJS section suggested by @kcullion above is fixed
    • Mobile behaviour is same as above, except one minor issue listed below
  • Minor issues/nitpicks found, to confirm with @kcullion:
    • "@2020 Overture" - Should this be bold/heavier font weight? Looks that way in Zeplin - Confirmed not needed
    • In prod site, Netlify logo in footer is lined up with left margin of last column of links, but in this updated landing page it is not - Should it be? - Confirmed not needed
    • On mobile, Netlify logo overlaps Privacy, Terms & Conditions links - Fixed in Minor Fixes for Overture.bio Mobile Version #94

image.png

Not in scope:

@b-f-chan
Copy link

b-f-chan commented Nov 3, 2020

All issues addressed (see above comment). We are good to complete & close this ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
canarie SP:3 Issue is estimated at 3 story points
Projects
None yet
Development

No branches or pull requests

5 participants