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.

Sign up for GitHub

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

Jump to bottom

docs(PPDSC-2172): Patterns index and overview pages #218

Merged
merged 60 commits into from
Jun 10, 2022
Merged

docs(PPDSC-2172): Patterns index and overview pages #218

merged 60 commits into from
Jun 10, 2022

Conversation

Srinivasan-Ramasamy
Copy link
Contributor

PPDSC-2172

What

  1. Index page creation.
  2. overview page creation.

I have done:

  • Written unit tests against changes
  • Written functional tests against the component and/or NewsKit site
  • Updated relevant documentation

I have tested manually:

  • The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
  • The screen reader reads and flows through the elements as expected.
  • There are no new errors in the browser console coming from this PR.
  • When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
  • The Playground feature is working as expected

Before:

After:

Who should review this PR:

How to test:

@Srinivasan-Ramasamy Srinivasan-Ramasamy added docs Improvements or additions to documentation WIP Work in progress labels Jun 1, 2022
@newskit-engineering
Copy link
Collaborator

You can preview these changes on:
Documentation Site: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2172-patterns-index-overview-pages
Storybook: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2172-patterns-index-overview-pages/storybook

@Srinivasan-Ramasamy Srinivasan-Ramasamy added the ready for design review Please assist in getting this reviewed label Jun 2, 2022
@Srinivasan-Ramasamy Srinivasan-Ramasamy added ready for review Please assist in getting this reviewed and removed WIP Work in progress labels Jun 7, 2022
baburay23
baburay23 reviewed Jun 7, 2022
View reviewed changes
site/routes.ts Outdated
{
title: 'Overview',
page: true,
id: '/patterns/overview',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey i see this maps to the form-index page at the moment, i assume its because we dont have an patterns overview page at the moment?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @baburay23 for reviewing the changes.

Yes, Patterns don't have overview page - only index page. So I rename it to patterns-index page and forms related files moved under forms folder - I hope this make more meaningful.

I've pushed updated changes. Thanks.

mstuartf
mstuartf previously approved these changes Jun 7, 2022
View reviewed changes
baburay23
baburay23 previously approved these changes Jun 8, 2022
View reviewed changes
@Srinivasan-Ramasamy
Copy link
Contributor Author

Thanks @mstuartf, @baburay23 for reviewing the code 👍

@Srinivasan-Ramasamy Srinivasan-Ramasamy dismissed stale reviews from baburay23 and mstuartf via c0c20ff June 8, 2022 13:26
mstuartf
mstuartf previously approved these changes Jun 8, 2022
View reviewed changes
mutebg
mutebg reviewed Jun 9, 2022
View reviewed changes
site/pages/patterns/patterns-index.tsx Outdated
@@ -0,0 +1,74 @@
import React from 'react';
import {Grid, ThemeProvider} from 'newskit';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this page should be called Overview, right? all other pages have been named Overveiw why is this eclusion

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes Stoyan, I was thinking the same. But initial discussions with spencer with story has index and form has overview page and Design team figma defined these namings. Please advise, still if you want to change it overview?

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @mutebg, as discussed changed index to overview page name. Changes are updated.

mutebg
mutebg reviewed Jun 9, 2022
View reviewed changes
Copy link
Contributor

@mutebg mutebg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as always, good job

@Srinivasan-Ramasamy Srinivasan-Ramasamy merged commit 8b21027 into main Jun 10, 2022
@Srinivasan-Ramasamy Srinivasan-Ramasamy deleted the docs/PPDSC-2172-patterns-index-overview-pages branch June 10, 2022 08:42
Xin00163 pushed a commit that referenced this pull request Oct 17, 2022
@Srinivasan-Ramasamy
docs(PPDSC-2172): Patterns index and overview pages (#218)
abd077c 
* docs(PPDSC-2172): Patterns overview and forms overview pages.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@baburay23 baburay23 baburay23 approved these changes

@mutebg mutebg mutebg approved these changes

@mstuartf mstuartf mstuartf left review comments

@jps jps Awaiting requested review from jps

@Xin00163 Xin00163 Awaiting requested review from Xin00163

@pdimova pdimova Awaiting requested review from pdimova

@Vanals Vanals Awaiting requested review from Vanals

@evgenitsn evgenitsn Awaiting requested review from evgenitsn

Assignees
No one assigned
Labels
docs Improvements or additions to documentation ready for review Please assist in getting this reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Srinivasan-Ramasamy @newskit-engineering @mutebg @mstuartf @baburay23