Update documentation #96

KVSRoyal · 2022-10-26T20:56:07Z

Prevent infinite load of PlatformTabs. These were trying to use router.isReady which shouldn't be used outside of useEffect (link). This causes a progress bar to appear until the user navigates to a different page and then navigates back (e.g. for the Asset Provide Plugin), so remove that.
The validations objects link under the Cross-field Validation section in Content/Assets & Views was broken. Add a link to a relevant validations page.
Use reliable local images for the Player logo and single/simple flow example.
Update the contributing documentation with the info I gathered while working on this so others don't need to.

Version

Published prerelease version: 0.3.0-next.6

Changelog

🚀 Enhancement

Core package organization, and renaming to ReactPlayer #93 (@adierkens)
Enhancement/Parser Rewrite for plugins #80 ([email protected] @mercillo)

🐛 Bug Fix

Update documentation #96 (@KVSRoyal)
run a separate workflow for forked PRs without write capable cache keys #97 (@hborawski)
[iOS] relax requirements for sending beacon metadata #88 (@hborawski)
[iOS] fix TestPlayer test helper dependency #83 (@hborawski)
[iOS] fix runtime warnings for published variables in Xcode14 #84 (@hborawski)
[iOS] make some additional properties public #82 (@hborawski)
change platform groupid #81 ([email protected] @brocollie08)
[iOS] add registerPlugin(_:) to HeadlessPlayer API #79 (@hborawski)
Cleanup Android dependencies #77 (@sugarmanz)

📝 Documentation

Add algolia search to /latest/ site #76 (@adierkens)

Authors: 8

@brocollie08
Adam Dierkens (@adierkens)
brocollie08 ([email protected])
Harris Borawski (@hborawski)
Jeremiah Zucker (@sugarmanz)
Kori South (@KVSRoyal)
Marlon Ercillo (@mercillo)
mercillo ([email protected])

hborawski · 2022-10-27T23:05:37Z

@KVSRoyal when you get a chance, rebase against main, fork build should work after #97

hborawski · 2022-10-28T20:27:46Z

docs/site/pages/content/assets-views.mdx

@@ -45,7 +45,7 @@ The `id` of the views are used in the navigation section to reference a specific

 ## Cross-field validation

-The other special property of a `view` vs. an `asset` is the addition of a `validation` property on the view. These contains [`validation` objects](../guides/validation) that are used for validations crossing multiple fields, and are ran on user navigation rather than data change.
+The other special property of a `view` vs. an `asset` is the addition of a `validation` property on the view. These contain [`validation` objects](../plugins/common-types#validations) that are used for validations crossing multiple fields, and are ran on user navigation rather than data change.


i think this should be referencing https://github.com/player-ui/player/blob/main/docs/site/pages/content/schema.mdx#validation rather than validations from a plugin

It doesn't seem like I can do a relative link for this (../content/schema#validation). Is it fine if I use the full link: https://github.com/player-ui/player/blob/main/docs/site/pages/content/schema.mdx#validation?

can you just do ./schema#validation since its also in the content folder?

Oh yeah, sorry. My bad. That also doesn't work.

brocollie08 · 2022-10-28T20:32:41Z

CONTRIBUTING.md

+* [npm >= 8.19.2](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+* [yarn >= 1.22.19](https://yarnpkg.com/)
+* [Swift >= 5.2](https://www.swift.org/download/)
+* [Android NDK = 19.2.5345600](https://github.com/android/ndk/wiki/Unsupported-Downloads#r19c). You'll need to add `ANDROID_NDK_HOME` to your environment manually.


We might need to explicitly call out the incompatibility with NDK version >21

do we need bazel 6.x to bump up the android ndk?

How's this?

Android NDK >= 19.2.5345600, <= 21. Any version > 22 will not work, period. You'll need to add ANDROID_NDK_HOME to your environment manually.

I looked around, it looks like it's not supported yet.. there's this PR but it's been up for a while and according to this thread, that will no longer be the solution going forward, and there's supposed to be a rules_android_ndk that supports NDK r25. I don't know if that'll require bazel 6.x atm

https://github.com/ahumesky/rules_android_ndk
this specifically says version 25, so i'm assuming 22, 23, 24 don't work lol

KetanReddy · 2022-10-28T21:18:47Z

docs/site/components/mdx-components.tsx

@@ -101,10 +101,6 @@ const PlatformTabs = (props: React.PropsWithChildren<unknown>) => {
    CodeTabsNameMap.has(c.props.mdxType.toLowerCase())
  );

-  if (!router.isReady) {


Good catch! I am trying to remember the reason for including this but it looks like its not needed anymore.

hborawski added the hacktoberfest label Oct 26, 2022

hborawski force-pushed the docs-update branch from 7a5ec61 to 4c0c37b Compare October 28, 2022 17:10

KVSRoyal force-pushed the docs-update branch from 1ae6ea0 to 523bfc0 Compare October 28, 2022 19:14

KVSRoyal added 2 commits October 28, 2022 15:15

prevent infinite load of platformtabs

4291878

add more contributing documentation

81aa458

KVSRoyal force-pushed the docs-update branch from 523bfc0 to 81aa458 Compare October 28, 2022 19:15

use local images for logo and simple flow

a6865ea

KVSRoyal marked this pull request as ready for review October 28, 2022 20:25

KVSRoyal requested review from KetanReddy and adierkens as code owners October 28, 2022 20:25

hborawski reviewed Oct 28, 2022

View reviewed changes

brocollie08 reviewed Oct 28, 2022

View reviewed changes

update schema link, mention that NDK > 21 is broken

1677f8b

hborawski approved these changes Oct 28, 2022

View reviewed changes

KetanReddy reviewed Oct 28, 2022

View reviewed changes

hborawski merged commit 208d499 into player-ui:main Oct 28, 2022

KVSRoyal deleted the docs-update branch October 28, 2022 21:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update documentation #96

Update documentation #96

KVSRoyal commented Oct 26, 2022 •

edited by intuit-svc

Loading

hborawski commented Oct 27, 2022

hborawski Oct 28, 2022

KVSRoyal Oct 28, 2022

hborawski Oct 28, 2022

KVSRoyal Oct 28, 2022

brocollie08 Oct 28, 2022

hborawski Oct 28, 2022

KVSRoyal Oct 28, 2022

brocollie08 Oct 28, 2022

brocollie08 Oct 28, 2022

KetanReddy Oct 28, 2022 •

edited

Loading

Update documentation #96

Update documentation #96

Conversation

KVSRoyal commented Oct 26, 2022 • edited by intuit-svc Loading

Version

🚀 Enhancement

🐛 Bug Fix

📝 Documentation

Authors: 8

hborawski commented Oct 27, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KetanReddy Oct 28, 2022 • edited Loading

Choose a reason for hiding this comment

KVSRoyal commented Oct 26, 2022 •

edited by intuit-svc

Loading

KetanReddy Oct 28, 2022 •

edited

Loading