Skip to content

Commit c21ea83

Browse files
tracyteeschloerice
andauthored
Getting Started update (#7398)
This PR updates the getting started section based on internal feedback: - Removes `/design`, `/develop`, `/shared-resources`, and `/patterns-components-and-tokens` pages - Copy edits on `/getting-started` and `/polaris-101` |Getting started|Polaris-101| |---|---| |![localhost_3000_getting-started](https://user-images.githubusercontent.com/18447883/196173478-9a80d21a-ebdf-47c0-b962-b3c1a9e91f07.png)|![localhost_3000_getting-started (1)](https://user-images.githubusercontent.com/18447883/196173407-92d6e2c8-ef22-434f-b12a-ad79791e5fe0.png)| Co-authored-by: Chloe Rice <chloe.rice@shopify.com>
1 parent 699b707 commit c21ea83

File tree

14 files changed

+53
-145
lines changed

14 files changed

+53
-145
lines changed

.changeset/bears-drink-oj-too.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'polaris.shopify.com': patch
3+
---
4+
5+
- Updated the "Getting started" and "Polaris 101" pages
6+
- Removed /design, /develop, /shared-resources, /patterns-components-and-tokens

polaris.shopify.com/content/getting-started/design.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

polaris.shopify.com/content/getting-started/develop.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

polaris.shopify.com/content/getting-started/index.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Quick start
2+
title: Getting Started
33
navTitle: Getting started
4-
description: Polaris is the design system for the Shopify admin. There are many layers to being successful with Polaris, but if you want to start experimenting, the first step is reading and downloading the resources.
4+
description: 'Polaris is the design system for the Shopify admin. If you’re just starting out with Polaris, here’s a list of recommended resources and guidance to get you started.'
55
keywords:
66
- about
77
- polaris
@@ -18,11 +18,34 @@ order: 1
1818
icon: HintMajor
1919
---
2020

21-
### Downloads and links
21+
## Design resources
2222

23-
For full descriptions of our resources, see the [develop](/getting-started/develop), [design](/getting-started/design), and [shared resources](/getting-started/shared-resources) sections.
23+
Shopify provides [Figma community resources](https://www.figma.com/@Shopify) for Polaris components, styles, and icons. If you are new to Figma, check out our [onboarding guide](https://www.figma.com/community/file/994263185745279952), or open Figma and start designing with the Polaris:
2424

25-
<!--prettier-ignore-->
26-
| Design | Develop | Start exploring | | |
27-
| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | --- | --- |
28-
| <ul><li>[ Design ](/design)</li><ul><li>[Component Figma library](https://www.figma.com/community/file/1111360433678236702)</li><ul><li>[Token Figma library](https://www.figma.com/community/file/1111359207966840858)</li><ul><li>[Icon Figma library](https://www.figma.com/file/mMHFt3kEDNjLMZWowi6gnt/Polaris-Icons?node-id=753%3A2)| </li><ul><li>[Component GitHub package repo](https://github.com/Shopify/polaris/tree/main/polaris-react)</li><ul><li>[Token GitHub package repo](https://github.com/Shopify/polaris/tree/main/polaris-tokens)</li><ul><li>[Polaris for VS Code extension](https://marketplace.visualstudio.com/items?itemName=Shopify.polaris-for-vscode)</li><ul><li>[Performing a release](https://github.com/Shopify/polaris/blob/main/documentation/Releasing.md) |</li><ul><li>[React component library](https://polaris.shopify.com/components)</li><ul><li>[Token library](https://polaris.shopify.com/tokens/colors)</li><ul><li>[Icon library](https://polaris.shopify.com/icons)</li><ul><li>[Patterns](/patterns)</li><ul><li>[Product content](/content/product-content)
25+
- [Component UI kit](https://www.figma.com/community/file/1111360433678236702)
26+
- [Style Library](https://www.figma.com/community/file/1111359207966840858)
27+
- [Icon Library](https://www.figma.com/file/mMHFt3kEDNjLMZWowi6gnt/Polaris-Icons?node-id=753%3A2)
28+
29+
## Development resources
30+
31+
The [Shopify/polaris GitHub repo](https://github.com/Shopify/polaris) is an open-source monorepo made up of NPM packages, VS Code extensions, Figma plugins, and this website. To get started, learn how to install and use the Polaris:
32+
33+
- [React components](https://github.com/Shopify/polaris/tree/main/polaris-react#using-the-react-components)
34+
- [Design tokens](https://github.com/Shopify/polaris/tree/main/polaris-tokens#installation)
35+
- [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Shopify.polaris-for-vscode)
36+
37+
## Tutorials
38+
39+
### [Build a Shopify app](https://shopify.dev/apps/getting-started/create)
40+
41+
In this tutorial, you'll create an app that merchants can access in the Shopify admin. You'll use an app initialization command that generates starter code for building your app, and sets up your development environment so that you can work with your app using [Shopify CLI](https://shopify.dev/apps/tools/cli).
42+
43+
Your app will use Polaris and [App Bridge](https://shopify.dev/apps/tools/app-bridge) while following the [App Design Guidelines](https://shopify.dev/apps/design-guidelines).
44+
45+
## Expand your knowledge
46+
47+
Polaris provides foundational design guidance for creating good merchant experiences. Here are some recommended resources to:
48+
49+
- [Experience Values](/foundations/experience-values)
50+
- [Design guidelines](/design)
51+
- [Product content](/content/product-content)

polaris.shopify.com/content/getting-started/patterns-components-and-tokens.md

Lines changed: 0 additions & 56 deletions
This file was deleted.
Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,30 @@
11
---
22
title: Polaris 101
3-
description: Learn what the Polaris design system is and how it’s used by UXers and developers to build world-class Shopify admin experiences.
3+
description: The Polaris design system is used by designers and developers to build world-class Shopify admin experiences.
44
keywords:
55
- polaris
66
- shopify admin
77
order: 0
88
---
99

10+
## What’s the Shopify admin?
11+
12+
Merchants set up their store, configure settings, and manage their business using the admin. It includes core aspects of the merchant’s business, including orders, products, and customers.
13+
14+
![Partial screenshots of the admin in mobile and web](/images/getting-started/polaris-101/mobile-web-admin@2x.png)
15+
1016
## What is Polaris?
1117

12-
Polaris is the design system for the Shopify admin. It’s the shared language that guides how we build high-quality merchant experiences, and is grounded in deep merchant understanding. The Polaris components are available for web, iOS, and Android. The design system is made up of design guidance, code libraries, development opinions, and API documentation on how to build merchant experiences for the Shopify admin. Learn more about the [foundational pieces](/getting-started/patterns-components-and-tokens) that make up the Polaris design system.
18+
Polaris is the design system for the Shopify admin. It’s the shared language that guides how we build high-quality merchant experiences.
1319

14-
## Who is Polaris for?
20+
The design system is made up of design guidance, code libraries, development opinions, and API documentation on how to build merchant experiences for the Shopify admin.
1521

16-
Polaris is used both internally at Shopify and externally by third-party developers and designers. The Shopify admin includes installable apps built by Shopify employees and third-party developers. Third-party developers can use App Bridge and Polaris to build their Shopify admin apps. Shopify admin apps are web-based and are embedded into the admin web, iOS, and Android platforms. To learn more about building Shopify apps check out [shopify.dev](https://shopify.dev/).
22+
## Who is Polaris for?
1723

18-
## What’s the Shopify admin?
24+
Polaris is used both internally at Shopify and externally by app developers and designers.
1925

20-
Merchants set up their store, configure settings, and manage their business using the Shopify admin. It includes core aspects of the merchant’s business, including orders, products, and customers.
26+
## What are Shopify apps?
2127

22-
The Shopify admin is available across web and native platforms. The Polaris design system is available on every platform the Shopify admin is built for.
28+
The admin includes installable apps that are distributed through the Shopify App Store. They enable merchants to add functionality to their stores without leaving the familiar environment of the admin.
2329

24-
![Partial screenshots of the admin in mobile and web](/images/getting-started/polaris-101/mobile-web-admin@2x.png)
30+
By building with Polaris and [App Bridge](https://shopify.dev/apps/tools/app-bridge) and following the [App Design Guidelines](https://shopify.dev/apps/design-guidelines), you'll create a streamlined experience with the rest of the Shopify admin.

polaris.shopify.com/content/getting-started/shared-resources.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

polaris.shopify.com/content/patterns/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ icon: BehaviorMajor
55
order: 6
66
newSection: true
77
---
8+
9+
![Design system building blocks, with pattern block highlighted.](/images/foundations/patterns/patterns@2x.png)

0 commit comments

Comments
 (0)