8000 Updates to UXP API reference by padmkris123 · Pull Request #61 · AdobeDocs/uxp · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Updates to UXP API reference #61

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
Merged
merged 25 commits into from
Oct 17, 2022
Merged

Updates to UXP API reference #61

merged 25 commits into from
Oct 17, 2022

Conversation

padmkris123
Copy link
Collaborator

Updated API reference as of UXP v6.3

Description

Changes from latest UXP source files that contain changes upto UXP v6.3

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Padma Krishnamoorthy and others added 20 commits October 3, 2022 15:16
Updating commands (WIP)
62fd1e4
< 8000 svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-git-commit">
@padmkris123
Update README.md
d12650a
Files that remove host application version
a8f7171
New APIs
ceeb711
Merge branch 'fix-pipeline' of github.com:AdobeDocs/uxp into fix-pipe…
24a7913 
…line
New APIs
5f62101
Updated relative paths
f98711b
update relative paths
4d72d59
New APIs
739d829
Manual corrections to File storage APIs based on https://adobe.enterp…
b3c0c78 
…rise.slack.com/files/T024GGQHD/F045GJTRYP5
Transclusions and side navigation links for new APIs
9f5ac05
New files for extra information - formatted manually
dbb4671
Removing APIs only available in future UXP version
b5122a5
Updated changes from torq-native
d4268e4
Fixes for broken links
56d5b13
Updated readme and npm commands
c093935
latest changes from source files
a803eaf
Changes to changelog, version etc
2ff28ae
New FileSystem API
e7ce427
Updated readme
56f0b60
pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial Review: FileSystem.md

A few requested changes.

pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: _translusions, reference-js.js (navigation structure) and src/pages/uxp

one requested change, other than that LGTM

pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: reference-css

Fixing inconsistencies, other than that LGTM

pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: README.md

pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: reference-html

LGTM, "request changes" for other areas, I have no requested changes for the reference-html part.

pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: reference-js/Global Members without HTML members

pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: Global HTML * Members

pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: os and shell modules

pklaschka
pklaschka reviewed Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial Review: uxp module things up to (but excluding) Persistent File Storage

pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: UXP Module persistent storage, versions, and plugin management APIs

src/pages/uxp/reference-js/Modules/uxp/Versions/Versions.md Show resolved Hide resolved
pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: reference-spectrum

pklaschka
pklaschka reviewed Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Partial review: versions.md and versions3P.md

This part looks good to me

pklaschka
pklaschka suggested changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

Overall review result

Thanks everyone involved for the great work that you've put into this request. It improves our documentation a lot!

As with any major changes, there are a few inconsistencies and similar things here and there. On the basis of these, I hereby request the changes mentioned above in the partial code reviews.

For these changes, we should both fix them in this pool request before merging it (or, if not possible in time, open corresponding issues to track them), but also look into fixing them in the source repository so that future documentation generations won't cause the same issues.

Again: thanks everyone for the awesome work on this pull request, apart from the inconsistencies mentioned above (and after fixing those), these changes look good to me.

This was linked to issues Oct 17, 2022
createPersistentToken() is actually asynchronous #54
Closed
Wrong parameters and examples in FileSystemProvider.getFileForSaving() #53
Closed
@pklaschka
Copy link
Contributor

I have resolved all the "data type normalization" review comments. The remaining comments fall into a few categories with varying severity (🔴 blocking: I wouldn't want to merge this PR with these issues remaining; 🟡 needs to be fixed as soon as possible, but not necessarily right now; and 🟢 nice-to-have)

🔴 : Wrong/misleading/confusing information (wrong return type, wrong parameter type)
🔴 : Duplicate source of truth (we shouldn't (without explaining comments) include both storage.md and the original files at the same time
🔴 : Encoding issues in files => this could break the page
🔴 🟡 : (things where I couldn't decide if they should be red and yellow are marked as such in the PR comments)
🟡 : missing information (missing types, etc.)
🟢 : cosmetic changes

padmkris123 and others added 4 commits October 17, 2022 15:18
@padmkris123 @pklaschka
Apply suggestions from code review
bfdbd8f 
Co-authored-by: Pablo Klaschka <pklaschka@users.noreply.github.com>
Code review changes
f75e310
Merge branch 'fix-pipeline' of github.com:AdobeDocs/uxp into fix-pipe…
0091b46 
…line
@padmkris123 @pklaschka
Apply suggestions from code review
0b2c8ba 
Co-authored-by: Pablo Klaschka <pklaschka@users.noreply.github.com>
pklaschka
pklaschka approved these changes Oct 17, 2022
View reviewed changes
Copy link
Contributor
@pklaschka pklaschka left a comment

Choose a reason for hiding this comment

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

LGTM! (🟡 comments should be fixed in the near future, but aren't blockers for this PR).

@padmkris123 padmkris123 merged commit dfa3cfc into main Oct 17, 2022
This was referenced Oct 18, 2022
Open
Open
Open
Open
Open
Open
Open
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pklaschka pklaschka pklaschka approved these changes

@oihamza oihamza Awaiting requested review from oihamza

@ErinFinnegan ErinFinnegan Awaiting requested review from ErinFinnegan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

createPersistentToken() is actually asynchronous Wrong parameters and examples in FileSystemProvider.getFileForSaving()
4 participants
@padmkris123 @pklaschka @sujaisivanandan @minjongsong
0