Seperate components into internal-only category #11382
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alex-page
requested review from
jzazove,
dominikwilkowski,
samerfahmy and
yesenia-perezcruz
jesstelford
reviewed
Jan 3, 2024
alex-page
force-pushed
the
internal-only-component-category
branch
2 times, most recently
from
9ff3fcb
to
22463b9
Compare
alex-page
force-pushed
the
internal-only-component-category
branch
from
22463b9
to
671f7c0
Compare
alex-page
commented
Jan 11, 2024
craigbrunner
approved these changes
Jan 12, 2024
themarkappleby
requested changes
Jan 12, 2024
There was a problem hiding this comment.
This is amazing, thanks so much @alex-page! Just a few minor questions/comments from me 👍
polaris.shopify.com/content/components/internal-only/loading.mdx
Outdated
Show resolved
Hide resolved
polaris.shopify.com/content/components/navigation/fullscreen-bar.mdx
Outdated
Show resolved
Hide resolved
polaris.shopify.com/src/components/StatusBanner/StatusBanner.tsx
Outdated
Show resolved
Hide resolved
- Point `internal-only` pages to other `internal-only` pages - Point public documentation to `App Bridge` docs - Remove banners from `internal-only` routes - Fix spacing in navigation Co-Authored-By: Mark Appleby <themarkappleby@gmail.com>
alex-page
force-pushed
the
internal-only-component-category
branch
from
82eb23e
to
92a446f
Compare
AnnaCheba
pushed a commit
to AnnaCheba/polaris
that referenced
this pull request
Apr 22, 2024
### WHY are these changes introduced? Application Developers trying to build applications with the current Polaris documentation are building poor experiences as they are using components that should not be used for application development. `Navigation` `Frame` `Toast`... will render incorrectly in apps and Application Developers need to use App Bridge API's to correctly build their user interface. This PR hopes to resolve this by: 1. Move the internal team documentation for components to a new category called `Internal only` 2. Deprecate the components for application developers and direct them to app bridge The goal of this PR is too: - Ensure all components can be used by application developers without issue - Friction is added to components like `<Modal>` `<Toast>` and `<Loading>` to ensure that Application Developers are not incorrectly using these components and going to use app bridge components - Ensure Shopify employees can still access these components despite them being in a new _more confusing_ location - Educate users without creating private documentation or shipping breaking changes - Alerts developers that these components can be removed in a future major version if we decide to move them to a private space ### WHAT is this pull request doing? - [x] Moves `<ContextualSaveBar>` `<Navigation>` `<TopBar>` `<Toast>` `<Modal>` `<Loading>` `<Frame>` into the Internal (auth required) component category - [x] New deprecated component pages for `<Navigation>` `<TopBar>` `<Toast>` `<Modal>` `<Loading>` `<Frame>` and directs users to App Bridge API's when they exist - [x] Adds banners and documentation for deprecated components - [x] Hides internal only components from search and components landing page - [x] Updates paths of component images - [x] Add authentication for `components/internal-only/**/*` - [x] Redirect component links in shopify.dev and polaris.shopify.com to `internal-only` path --------- Co-authored-by: Mark Appleby <themarkappleby@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Application Developers trying to build applications with the current Polaris documentation are building poor experiences as they are using components that should not be used for application development.
NavigationFrameToast... will render incorrectly in apps and Application Developers need to use App Bridge API's to correctly build their user interface.This PR hopes to resolve this by:
Internal onlyThe goal of this PR is too:
<Modal><Toast>and<Loading>to ensure that Application Developers are not incorrectly using these components and going to use app bridge componentsWHAT is this pull request doing?
<ContextualSaveBar><Navigation><TopBar><Toast><Modal><Loading><Frame>into the Internal (auth required) component category<Navigation><TopBar><Toast><Modal><Loading><Frame>and directs users to App Bridge API's when they existcomponents/internal-only/**/*internal-onlypath