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

GH-246: Add doc for infusion 4.5.0 release and update package dependencies #247

Merged
merged 9 commits into from Nov 25, 2022

Conversation

cindyli
Copy link
Member

@cindyli cindyli commented Oct 21, 2022

This pull request does:

  1. Add documentation for the infusion 4.5.0 release;
  2. Update package dependencies. The only package that is not yet upgraded is "foundation-sites". The infusion doc site uses css files from this package as base styles. As the new release of "foundation-sites" no longer includes "normalize.css" and has a bunch of styling changes in itself, upgrading it requires further styling fixes on the doc site. If we decide to upgrade this package, it probably worth a separate ticket.

@cindyli cindyli requested a review from amb26 October 21, 2022 15:53
@cindyli cindyli self-assigned this Oct 21, 2022
<section class="flc-prefsEditor-separatedPanel fl-prefsEditor-separatedPanel">
<!--
This div is for the sliding panel bar that shows and hides the Preference Editor controls in the mobile view.
A separate panel bar for mobile displays is needed to preserver the correct tab order.
Copy link
Member

Choose a reason for hiding this comment

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

typo preserver -> preserve


### UI Options Template in Infusion 4.5

Remove the css selector `flc-prefsEditor-iframe` from the div that will contain the Preference Editor component.
Copy link
Member

Choose a reason for hiding this comment

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

I think it might confuse people to only quote the markup which is now obsolete and give them an instruction how to correct it - perhaps better to quote the corrected markup in full?

@@ -44,7 +44,7 @@ the meaning and form of the context name can vary and have a different meaning i
<li>
an entire <code>&lt;reference&gt;</code> string in itself. This is useful in highly
dynamic cases where the context name should be determined from some other options
material, e.g. <code>{{that}.options.targetContext}</code>
material, e.g. <code>{% raw %}{{that}.options.targetContext}{% endraw %}</code>
Copy link
Member

Choose a reason for hiding this comment

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

What is the %raw% directive issued against? Does the {{ confuse the markdown processor somehow?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, exactly. The new version of Eleventy parses strings in double curly brackets as template vars.

"lunr": "2.3.9",
"markdown-it-anchor": "8.4.1",
"octicons": "3.1.0",
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure what the cause is, but I got an error running npm run build or npm run start complaining that markdown-it itself was not installed.

[dev  ] [11ty] Eleventy CLI Fatal Error: (more in DEBUG output)
[dev  ] [11ty] 1. Error in your Eleventy config file 'E:/source/gits/infusion-docs/.eleventy.js'. You may need to run `npm install`. (via EleventyConfigError)
[dev  ] [11ty] 2. Cannot find module 'markdown-it'

Adding the line here:

    "markdown-it": "13.0.1",

made the problem go away

@@ -231,8 +231,8 @@ fluid.defaults("demo.panels.language", {
protoTree: {
Copy link
Member

Choose a reason for hiding this comment

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

Not part of this work, but we could correct a typo here on line 63

Preference Maps are **only** required if you are working with
[schemas](PrimarySchemaForPreferencesFramework.md))

there is an extra ) after the link here

@cindyli
Copy link
Member Author

cindyli commented Nov 22, 2022

Good catch, @amb26. All addressed. This pull request is ready for another look. Thanks.

@amb26 amb26 merged commit 171ad71 into fluid-project:main Nov 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants