Storybook updates by erikyo · Pull Request #148 · WordPress/wp-feature-notifications

erikyo · 2023-01-20T18:55:05Z

What?

#147 Add an autogenerated documentation to Github pages

Why?

Actually we haven't a (easy to reach) user documentation.

How?

Thanks to the capability of storybook to generate a static website we have the possibility to see the components in action and have a mini-site to show the documentation (while still using md files, if we prefer, as I did here)

close #147, and closes #241

I had to synchronize the branch with the master, which also forced me to update some dependencies. Little harm either way, maybe we get fewer alerts from dependbot

erikyo · 2023-03-26T12:07:11Z

-# Database Schema
-
-### wp_notifications table
-* id (int) 11 auto_increment `ID of the notification.`
-* sender_key `Sender of the notification. As defined by the plugin or theme`
-* timestamp `Timestamp of when the notification was triggered.`
-* recipient_key `Single notification recipient. As defined by the plugin or theme`
-* title_key `Notification title key. As defined by the plugin or theme`
-* message_key `Notification message key. As defined by the plugin or theme`  (optional)
-* action_link `Correctly formatted URL to an internal or external action.`
-* status enum (READ, UNREAD) `Notification status.`
-
-See the Translations document for details on title_key and message_key fields


i'm reverting that changes... it's due a failed merge! sorry

johnhooks

LGTM

erikyo · 2023-03-26T12:38:10Z

^^ updating deps wasn't something that I didn't want to do in this pr, but I was forced

Sephsekla

This is great, it's awesome to have such nice docs!

erikyo · 2023-03-27T14:29:41Z

TODO: after creating the master branch we need to automate this documentation build process with the ci and run it at every merge between development and master

johnhooks · 2023-04-02T12:55:42Z


 /node_modules/
 /vendor/
+


@erikyo did you mean to add a line here?

no... however it goes, let's say a collateral damage of the lint. I would leave it since, theoretically, the empty end line is required at the end of each document

Makes sense to me, I agree empty lines between groups is standard.

but you are right maybe a comment would be nice to separate things (for example, I hadn't noticed that he had a line underneath)

I've started to make some updates to this in #240

johnhooks · 2023-04-02T12:59:11Z

@erikyo I don't like the idea of all the storybook build artifacts being checked into the repo. Is the docs for publishing on GitHub pages?

johnhooks · 2023-04-02T13:02:15Z

Can we add a CI workflow for publishing to GitHub pages?

erikyo · 2023-04-02T13:06:02Z

Can we add a CI workflow for publishing to GitHub pages?

I have already created an issue for this, however I would do it in a separate pr. if you think we'll take care of it shortly I'll remove what we have now in the docs folder, otherwise maybe we'd better leave it there

johnhooks · 2023-04-02T13:07:22Z

I'll help you resolve it now. If we check those in, I think we will regret it quickly.

erikyo · 2023-04-02T13:13:05Z

This is the CI workflow used alongside the Gutenberg repository
https://github.com/WordPress/gutenberg/blob/trunk/.github/workflows/storybook-pages.yml

Seems quite easy to add, what o you think @johnhooks?

johnhooks · 2023-04-02T13:15:20Z

@erikyo yes that looks perfect, but lets do it in a separate PR. Getting storybook functional is a very different issue than deploying to GitHub Pages.

We will also probably need @Sephsekla to enable using GitHub Actions to build GitHub Pages in the settings tab of the repo.

johnhooks

LGTM

johnhooks

There were no changes since the last approval, only rebased onto develop. LGTM

erikyo · 2023-04-11T15:56:12Z

@Sephsekla we need to merge this one after #252 in order to update this one with the new drawer before updating the whole repo. Please take care of that one first, both of these pr's are IMHO a big and nice advancement, sorry for the number of commits/files changed but since those are structural changes doing them in various PR's would have stalled development considerably

… facilitate the ci action

Sephsekla

Nice!

Added one suggestion around naming, it doesn't necessarily have to be a blocker at this stage though.

Sephsekla · 2023-04-13T07:41:00Z

Only just noticed this, but could we update the naming here to reference WP Feature Notifications instead of WP Notify? Similar to what @johnhooks has been doing in PHP.

Many of these are already updated in the storybook-wip branch, my only doubt was about css custom props because wp-notification-feature is really too long to be used on this purpose! @Sephsekla @johnhooks probably because of these cases the "wp-notifications" prefix might work better? What do you think?

I support this wp-feature-notifications is too long of a prefix, or even adopting something that is shorter like the performance plugin did:

https://github.com/WordPress/performance/blob/f7a46205dd2818cf59786d8d0a0370a78e3704c4/load.php#L39

I don't think we want to change the rest api to... do we?

/wp-json/wp-feature-notifications/v1/notifications

I can't think of anything that rolls off the tounge as well as perflab though... featnote sounds awful.

Sephsekla · 2023-04-13T07:44:23Z

Oops, hadn't noticed that this now has a couple of conflicts from the drawer update. As soon as those are resolved,re-request review and I can approve.

updates to storybook 7.0.4

erikyo · 2023-04-13T11:05:10Z

Oops, hadn't noticed that this now has a couple of conflicts from the drawer update. As soon as those are resolved,re-request review and I can approve.

We have branched this PR to keep things clean, we are working on... and we are close to get it fully working! In addition there are some improvements over the previous version, such as the default open drawer (cc @johnhooks) and some useful modules as the one that performs a a11y checking automatically for each component.

erikyo · 2023-04-14T13:16:32Z

@johnhooks, also we might want to provide in this PR the workflow for publishing the storybook? An idea of what it needs to look like is this one (and I got it here)

johnhooks · 2023-04-14T13:40:17Z

Setup node and install deps. I think it would work if you move into the storybook directory first`. If not, at least copy the caching logic to speed up the npm install.

            - name: Setup Node.js and install dependencies
              uses: ./.github/setup-node

Scratch that one above, I didn't realized that second one you linked is the Gutenberg repo. There are some changes I would suggest, can you add it to this PR and I'll make some inline comments?

erikyo · 2023-04-14T13:50:06Z

@johnhooks since i am not sure, I would prefer if you could add the workflow part to this PR, thanks! (I believe you have all the permissions to do that, but if not tell me)

…e the first notice of the context "adminbar")

johnhooks

LGTM 🤘🏻

mirka · 2023-04-17T19:37:18Z

@mirka can you tell me what is wrong here?

Apologies for the late response as I was catching up from vacation! Glad you all got it sorted 👍

erikyo added the documentation Improvements or additions to documentation label Jan 20, 2023

erikyo requested a review from Sephsekla March 18, 2023 11:22

erikyo force-pushed the docs/storybook branch from 63c46c0 to 09a7368 Compare March 26, 2023 11:41

erikyo commented Mar 26, 2023

View reviewed changes

johnhooks reviewed Mar 26, 2023

View reviewed changes

Comment thread package.json Outdated

johnhooks reviewed Mar 26, 2023

View reviewed changes

Comment thread package.json

erikyo force-pushed the docs/storybook branch from 80bb9cc to 431d1ad Compare March 26, 2023 12:10

johnhooks reviewed Mar 26, 2023

View reviewed changes

Comment thread src/storybook/stories/docs/database-schema.md Outdated

johnhooks reviewed Mar 26, 2023

View reviewed changes

erikyo requested a review from johnhooks March 26, 2023 12:38

erikyo changed the title ~~setup storybook as repo documentation~~ Storybook updates Mar 26, 2023

Sephsekla previously approved these changes Mar 27, 2023

View reviewed changes

erikyo dismissed Sephsekla’s stale review via 0d8efb5 March 27, 2023 14:26

erikyo mentioned this pull request Mar 29, 2023

Automate documentation build process #193

Closed

erikyo requested a review from Sephsekla March 29, 2023 18:44

johnhooks reviewed Apr 2, 2023

View reviewed changes

erikyo force-pushed the docs/storybook branch from 0d8efb5 to f7c4562 Compare April 2, 2023 13:27

erikyo requested a review from johnhooks April 2, 2023 13:32

johnhooks approved these changes Apr 2, 2023

View reviewed changes

johnhooks previously approved these changes Apr 2, 2023

View reviewed changes

erikyo mentioned this pull request Apr 2, 2023

Storybook as repo documentation #147

Closed

erikyo and others added 9 commits April 12, 2023 21:13

setup storybook as repo documentation

4ec7f08

updates to storybook 7 / move the stuff to ./storybook/ in order to…

cc19762

… facilitate the ci action

enable scss // better dependencies setup

d93db34

importing the root package json worked!

a882041

moving to storybook 7 - components integration

5172a80

registers the store

b8af641

working hub

8fc5fc8

Dashboard overload with multiple notices

9672dfe

feature: add useControlledState

2935793

Sephsekla previously approved these changes Apr 13, 2023

View reviewed changes

Bell icon / Headbar style

5878b4a

updates to storybook 7.0.4

erikyo added 3 commits April 14, 2023 01:07

a better footer button style (also moves the shadow below it)

41bfb31

fixes the store registration/fetching issues

243dea6

cleanup

e865d07

erikyo dismissed Sephsekla’s stale review via e865d07 April 14, 2023 12:58

erikyo force-pushed the docs/storybook branch from ca43764 to e865d07 Compare April 14, 2023 12:58

johnhooks requested changes Apr 14, 2023

View reviewed changes

Comment thread storybook/stories/assets/fake_api.json Outdated

removes jsondata from stories assets as suggested by @johnhooks

8fa4239

erikyo requested review from Sephsekla and johnhooks April 14, 2023 15:20

filters the jsondata in order to get the first of a type (in this cas…

4f46a50

…e the first notice of the context "adminbar")

johnhooks approved these changes Apr 14, 2023

View reviewed changes

erikyo merged commit d5680de into WordPress:develop Apr 14, 2023

Conversation

erikyo commented Jan 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

How?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

johnhooks left a comment

Choose a reason for hiding this comment

Uh oh!

erikyo commented Mar 26, 2023

Uh oh!

Sephsekla left a comment

Choose a reason for hiding this comment

Uh oh!

erikyo commented Mar 27, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

johnhooks commented Apr 2, 2023

Uh oh!

johnhooks commented Apr 2, 2023

Uh oh!

erikyo commented Apr 2, 2023

Uh oh!

johnhooks commented Apr 2, 2023

Uh oh!

erikyo commented Apr 2, 2023

Uh oh!

johnhooks commented Apr 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnhooks left a comment

Choose a reason for hiding this comment

Uh oh!

johnhooks left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

erikyo commented Apr 11, 2023

Uh oh!

Sephsekla left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sephsekla commented Apr 13, 2023

Uh oh!

erikyo commented Apr 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erikyo commented Apr 14, 2023

Uh oh!

johnhooks commented Apr 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

erikyo commented Apr 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

johnhooks left a comment

Choose a reason for hiding this comment

Uh oh!

erikyo commented Jan 20, 2023 •

edited

Loading

johnhooks commented Apr 2, 2023 •

edited

Loading

johnhooks left a comment •

edited

Loading

erikyo commented Apr 13, 2023 •

edited

Loading

johnhooks commented Apr 14, 2023 •

edited

Loading

erikyo commented Apr 14, 2023 •

edited

Loading