Skip to content
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.

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

Adding a toolbox directory and the FDC3 Explained app #367

Closed
wants to merge 83 commits into from

Conversation

rikoe
Copy link
Contributor

@rikoe rikoe commented Apr 19, 2021

Let the tooling project live long and prosper!

Copy link
Contributor

@kriswest kriswest left a comment

Choose a reason for hiding this comment

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

@donbasuno @rikoe I'd like to see this PR move forward and get merged - however I think it needs a few changes:

  1. Ensure all files encapsulated in a folder under the 'toolbox' folder to ensure we can use it for other tools, i.e. toolbox/fdc3-explained
    • Rename the root page from toolbox/fdc3_explained.html to toolbox/fdc3-explained/index.html (and correct relative URLs in that file).
    • Also move toolbox/fdc3_explained_logo.svg -> toolbox/fdc3-explained/fdc3_explained_logo.svg
  2. Remove duplicate files:
    • Is toolbox/legacy.html still relevant? if superceded by toolbox/fdc3-explained/1.0/index.html please remove it.
    • website/static/demos/fdc3_explained.html appears to be another duplicate
  3. Ensure that the 1.2 version uses the the fdc3.getInfo() function to get provider details - meaning vendor specific code can be removed
  4. Remove vendor specific manifest files in toolbox/openfin directory
    • these include URLs that point to https://donbasuno.github.io, rather than final location in the FDC3 repository
    • A sample appD entry would be a more appropriate way of demonstrating how to include the app in your desktop agent.
  5. Add a Readme file to the toolbox/fdc3-explained folder

Once these files are included in the repository, we can open a separate PR to host them as part of the website and to create an implementations page and link to them.

Comment on lines +111 to +130
function getPlatform() {

// TODO: add G42 to vendors
if (window.FSBL) {
window.FSBL.getFSBLInfo().then((info) => {
document.getElementById('providerDetails').innerHTML = "Finsemble Version:" + info.FSBLVersion;
});
} else if (window.fin) {
fin.desktop.Application.getCurrent().getInfo((info) => {
document.getElementById('providerDetails').innerHTML = info.manifest.startup_app.name
});
} else if (window.fdc3) {
document.getElementById('providerDetails').innerHTML = "FDC3 Desktop Agent Chrome Extension";
}
else {
// no need to update the DOM there is already a default message just return
return
}

}
Copy link
Contributor

Choose a reason for hiding this comment

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

getPlatform should be updated to use fdc3.getInfo() to get platform metadata. Vendor specific code should be removed

@@ -0,0 +1,192 @@
<html>
Copy link
Contributor

Choose a reason for hiding this comment

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

This file appears to be a legacy copy of the FDC3Explained page - it should probably be removed.

@rikoe
Copy link
Contributor Author

rikoe commented Sep 14, 2021

Thanks for this list @kriswest - I've been meaning to my comments to this PR for a while.

In addition to the tasks you mention, we will need to figure out how deployment is going to work, as it won't work as is. In the source repository, GitHub pages is used to just deploy what is in the toolbox folder as a website, but in this repository it works differently.

We deploy the content of the website folder to GitHub pages via Docusaurus, so to get this deployed properly, we would either have to make the toolbox a subfolder of website/static, or have a build process that takes the files from the toolbox folder and adds them to the website folder at build time (or some other kind of consolidation between the two). There are trade-offs with all the possible approaches that I am happy to discuss.

The other issues I would like to resolve are:

  • Inconsistency in look-and-feel between the different versions of FDC3 Explained for different versions of FDC3
  • Not all operations being supported for FDC3 1.2
  • Inconsistent/confusing behaviour when running the FDC3 explained website just from the browser, outside of the context of the context of a desktop agent
  • Code duplication, where possible

@kriswest kriswest added enhancement New feature or request toolbox Apps or code that isn't part of the standard but supports it use labels Sep 17, 2021
@kriswest kriswest linked an issue Sep 21, 2021 that may be closed by this pull request
@kriswest kriswest mentioned this pull request Sep 21, 2021
14 tasks
@rikoe
Copy link
Contributor Author

rikoe commented Dec 26, 2021

Closing in favour of #535

@rikoe rikoe closed this Dec 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-present enhancement New feature or request toolbox Apps or code that isn't part of the standard but supports it use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

FDC3 Explained - demo app for beginners?
5 participants