Skip to content
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.

Update InterfaceOverview and GroupData for new event organisation #1315

Closed
wbamberg opened this issue Apr 11, 2019 · 7 comments
Closed

Update InterfaceOverview and GroupData for new event organisation #1315

wbamberg opened this issue Apr 11, 2019 · 7 comments
Assignees

Comments

@wbamberg
Copy link

This is a work item for #685, and was originally discussed in #906.

This item also depends on #1314 and #1313.

Currently, events are listed in the GroupData JSON macro. and are referenced from there by other macros for building sidebars and other content.

After the event ref work, events will live directly under APIs, and should instead be treated more like properties and methods of those APIs.

In this user story we will:

  • update the InterfaceOverview macro to remove its dependency on GroupData
  • update GroupData itself to remove the event listings

AC are that both those changes are committed to KumaScript, deployed, and verified.

@ExE-Boss
Copy link

ExE-Boss commented Apr 11, 2019

I’m removing the {{InterfaceOverview}} GroupData dependency in mdn/kumascript#1073.

@wbamberg
Copy link
Author

Thanks @ExE-Boss . But removing the GroupData dependency from InterfaceOverview is a 6-line change, and mdn/kumascript#1073 adds 6000 lines. I'd really much rather we do this in small pieces.

@ExE-Boss
Copy link

ExE-Boss commented Apr 11, 2019

That’s because mdn/kumascript#1073, depends on mdn/kumascript#1093, which adds the necessary utility functions to write the tests for {{InterfaceOverview}} without reinventing the wheel1 in every maceo test.

In fact, most of those lines are actually from the test fixtures.


1 By “reinventing the wheel” I’m referring to mocking macro output and loading test fixtures.

@wbamberg
Copy link
Author

When I wrote this I had expected to be removing events from GroupData: now I understand it better I won't be doing that.

See #1314 (comment) for a description of what I am intending to do to GroupData, and mdn/kumascript#1136 for the PR that does it.

Since group.events will still exist, there's now no need to update InterfaceOverview as part of this work.

@ExE-Boss
Copy link

Actually, {{InterfaceOverview}} will still need to be updated to properly handle event subpages.

@wbamberg
Copy link
Author

The work I am doing here is the minimum needed to stop InterfaceOverview from breaking as a result of the event refactoring work. For various reasons, I'm not adding extra features to InterfaceOverview.

As far as I can see, InterfaceOverview would not be broken by the event refactoring so the "minimum needed" is nothing. In particular I don't think I need to update it to "properly handle event subpages" in order for it not to be broken by the event refactoring.

If I'm wrong I'd love to know just how the event refactoring would break it and which changes are needed to fix that (although given that this macro has *** EXPERIMENTAL - DO NOT USE! *** across the top I'm reluctant to spend much time on it).

@wbamberg
Copy link
Author

wbamberg commented May 9, 2019

This is merged and deployed, see #1314 (comment).

@wbamberg wbamberg closed this as completed May 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants
@wbamberg @jmswisher @ExE-Boss and others