solution.js icon indicating copy to clipboard operation
solution.js copied to clipboard

Updated documentation

Open MikeTschudi opened this issue 1 year ago • 1 comments

MikeTschudi avatar Aug 15 '24 14:08 MikeTschudi

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (04a4fb3) to head (449531f).

Additional details and impacted files
@@            Coverage Diff            @@
##           develop     #1488   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          150       150           
  Lines         8066      8066           
  Branches      1851      1851           
=========================================
  Hits          8066      8066           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Aug 15 '24 15:08 codecov[bot]

image


The description of things is alittle confusing, I guess because it uses the same words to describe things. I understand an item becomes a template. Then is Solution Item an actual thing item in an AGO org?

The also, is Item Templates just really template(s) or is this something else?

previnWong avatar Aug 22 '24 22:08 previnWong

I like build.bat runs everything for the end user. But something that I found lacking in the experience was a "call to action". Either in the document or as a person that just finished running build.bat.

Maybe we should have a website that loads when build.bat finishes that open a page with links to all the demos so a user can test the demos right away. Like launch \solution_js\demos\index.html

Or have in the document a path to a global demo page that has all the demos a user could run and try.

previnWong avatar Aug 22 '24 22:08 previnWong

image

The description of things is alittle confusing, I guess because it uses the same words to describe things. I understand an item becomes a template. Then is Solution Item an actual thing item in an AGO org?

The also, is Item Templates just really template(s) or is this something else?

It is awkward that we're using the same item and term to describe two ideas. How about this version?


A Solution ArcGIS Online Item can take two forms:

  1. A Solution Template resides in a host ArcGIS Online organization. It contains a list of templates of ArcGIS Online items that work together. It is used to deploy a Solution and its items into destination ArcGIS Online organizations.
  2. A Deployed Solution resides in a destination ArcGIS Online organization. It is created when a Solution is deployed and contains a list of references to items deployed for a Solution; it serves as a table of contents for the deployment. This grouping of references also simplifies deleting the deployed Solution.

MikeTschudi avatar Aug 22 '24 23:08 MikeTschudi

Thank you for the comments, @previnWong

I updated README.md and Getting Started.md for

  • description of a Solution item
  • building to the point to running the demos
  • unit testing on Edge and Safari
  • pre-commit fix
  • srihash link
  • restored testing on Edge
  • added doc about adding a new package

Other:

  • Testing on Safari: I haven't succeeded in building it on MacOS; build.sh works on Linux systems, but not MacOS. I added the npm command because Karma supports the browser, but the build needs to be resolved.
  • Due to permissions required by a website, it's not possible for the build script to launch a welcome site. But I added how to set up the demos list site to Getting Started.
  • We don't want to support a public demos page, so I just added instructions for one's own demos page
  • I'm open to learning more whether we should not write out both esm & cjs the first time
  • I'm open to adding documentation about hot file loading & npm run watch

MikeTschudi avatar Aug 23 '24 23:08 MikeTschudi