empty client guides published with this sim

[zepumph]

In https://phet-dev.colorado.edu/html/ph-scale/1.4.0-rc.1/phet-io/, there is a row in the table for the client guide and client request. Both of these are empty files (https://github.com/phetsims/phet-io-client-guides/tree/master/ph-scale)

Over in https://github.com/phetsims/phet-io-client-guides/issues/2 @chrisklus and I got rid of all client guides that were blank except for upcoming releases. I guess that I forgot that ph-scale was not going to use this new, md rendered client guide, and would instead just use google docs. @arouinfar is that true? If so, ph-scale (and likely ph-scale-basics) should have their folders removed from phet-io-client-guides/ before publication (and patched into the rc branch).

• @arouinfar please confirm that there will not be phet-io-client-guides md files for ph-scale(-basics)
• a developer to remove these folders on master (simple commit)
• a developer (likely @pixelzoom) to patch this into rc branches accordingly.

[arouinfar]

@zepumph we do not intend to deliver any more google docs to the client, and all documentation should go in this repo. The rc's for ph-scale and ph-scale-basics were published before I thought about the fact that their documentation still needs to be converted to md, but I will definitely have those files converted before rc testing wraps up.

[pixelzoom]

@arouinfar Please let me know when the pH Scale doc have been converted, so that I can patch the 1.4 release branch.

[pixelzoom]

@arouinfar said:

... I will definitely have those files converted before rc testing wraps up

If these are to be published with the RC, then they should be patched into the 1.4 branches before the final RC is delivered to QA for test. And it's difficult to identify "the final RC" until after it's been tested.

I'm also not clear on why @zepumph is assigned and @arouinfar is not, so assigning them both.

[arouinfar]

I'm tracking client guide work in https://github.com/phetsims/phet-io-client-guides/issues/5

[zepumph]

@arouinfar please assign @pixelzoom to this issue when phet-io-client-guides/ph-scale and phet-io-client-guides/ph-scale-basics are ready to be applied to the rc branch. @pixelzoom when that time comes, I would recommend pulling all, building both sims, and then spot checking two links in each wrapper index: "PhET-iO Guide" and "Client Requests". The main thing would be to make sure that there are no templated vars leaking into the build version, and the links are not broken.

Unassigning. Let me know if I can help!

[arouinfar]

I've finished converting the guides to .md, and phet-io-client-guides/ph-scale and phet-io-client-guides/ph-scale-basics are now ready to be applied to the rc branch @pixelzoom. The temporary pdf's still need to be deleted, but I'll leave those alone until QA is finished with this rc test.

[pixelzoom]

@arouinfar I don't see any commits associated with this issue, so I don't know what to cherry-pick. Please locate your commits in the GitHub UI, and label them with this issue number.

[arouinfar]

Work was tracked in https://github.com/phetsims/phet-io-client-guides/issues/5, but I commented on the commits so they show up here too.

[pixelzoom]

I made a couple of edits in the above commits, but overall these docs look great.

[pixelzoom]

Changes have been cherry-picked. Verified by viewing the ph-scale-1.4 and ph-scale-basics-1.4 branches of phet-io-client-guides. To be regression tested in the next RC.

[pixelzoom]

To verify in the next RC:

1. Go to the wrapper index
2. Verify that the "PhET-iO Guide" link works
3. Verify that the "Client Requests" link works

[pixelzoom]

@arouinfar It looks like the temporary pdf (guides) were deleted in https://github.com/phetsims/phet-io-client-guides/commit/5996b84d11dba871fed952f830b6ba9caef4b4d7 and https://github.com/phetsims/phet-io-client-guides/commit/12a7d03989f30605a4ea04ca561b89480e5172b0. Are those the complete sets of commits? They also need to be delete in the 1.4 branches.

[arouinfar]

@pixelzoom it doesn't look like the .pdf's were ever in those branches.

[pixelzoom]

OK, thanks @arouinfar.

[KatieWoe]

Checked on Win 10 Chrome in 1.5.0-dev.1. Links work, closing