Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Document the new action-items widget type #652

Merged
merged 2 commits into from
Jun 29, 2017
Merged

Document the new action-items widget type #652

merged 2 commits into from
Jun 29, 2017

Conversation

thevoiceofzeke
Copy link
Contributor

@thevoiceofzeke thevoiceofzeke commented Jun 29, 2017 •
edited
Loading

Companion to uportal-app-framework#465

In this PR:

  • Added widget type documentation explaining how to use the new Action Items widget.

Screenshot

screen shot 2017-06-29 at 11 50 23 am

Contributor License Agreement adherence:

@thevoiceofzeke thevoiceofzeke mentioned this pull request Jun 29, 2017
Merged
1 task
ChristianMurphy
ChristianMurphy approved these changes Jun 29, 2017
View reviewed changes
Copy link
Contributor

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

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

LGTM 👍
Thanks for adding a screenshot and language flags to the snippets!

docs/widgets.md
<name>widgetConfig</name>
<value>
<![CDATA[{
"actionItems": [
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a way to avoid embedding JSON in XML?
Mixed markup language documents can be difficult to debug.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That decision predates me, but I imagine it was done so the configuration was simpler to consume in the various places it's needed. @apetro can probably elaborate.

Copy link
Contributor

Choose a reason for hiding this comment

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

Someday the neighborhood of portlet-definitions will evolve, either such that portlet-definition entity files can be represented as something other than XML or such that we're not using portlet-definitions as the substrate for representing widget configuration. In the meantime, widgets ride along as magic portlet preferences in portlet-definition entity files.

@thevoiceofzeke thevoiceofzeke merged commit 77e8eec into uPortal-Attic:master Jun 29, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@davidmsibley davidmsibley davidmsibley approved these changes

@apetro apetro apetro approved these changes

@ChristianMurphy ChristianMurphy ChristianMurphy approved these changes

@vertein vertein vertein approved these changes

Assignees
No one assigned
Labels
patch-suitable-bug-fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@thevoiceofzeke @davidmsibley @apetro @ChristianMurphy @vertein