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

Update template for monolithic operator pages #4

Merged
merged 5 commits into from
Aug 2, 2024

Conversation

cjsha
Copy link
Member

@cjsha cjsha commented Aug 2, 2024

  • MRef.extension modified to inherit contextTask info from MultiDeviceFactory for aggregate nodes as well as
  • Remove rhs2116 and miniscope tutorial placeholders
  • Point to later repo in source code
  • Mustache templating refactored to have table and diagram partial templates to reuse reoccuring html patterns
  • css modified to make headers more distinctive
  • No more filtering in filter.yml - toc organized using toc.extension.js
  • Not filter enums allows the cloud build to reflect my local build (which was coming out different because the api folder never clears)
  • Replace the word "node" with "operator"
  • node in diagram is now aligned with the input/output boxes and the grey arrows

- MRef.extension modified to inherit contextTask info from
  MultiDeviceFactory for aggregate nodes as well as
- Remove rhs2116 and miniscope tutorial placeholders
- Point to later repo in source code
- Mustache templating refactored to have table and diagram partial templates to
  reuse reoccuring html patterns
- css modified to make headers more distinctive
- No more filtering in filter.yml - toc organized using toc.extension.js
- Not filter enums allows the cloud build to reflect my local build
  (which was coming out different because the api folder never clears)
- Replace the word "node" with "operator"
- node in diagram is now aligned with the input/output boxes and the
  grey arrows
@cjsha cjsha requested a review from bparks13 August 2, 2024 21:47
Copy link
Member

@bparks13 bparks13 left a comment

Choose a reason for hiding this comment

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

Looks good to me! Just a couple comments, let me know about the commented code and then we can merge if the checks clear.

template/ManagedReference.extension.js Outdated Show resolved Hide resolved

{{/oe.operatorType}}

{{#oe.hasSubOperators}}

<h2>Properties</h2>

<div>{{name.0.value}} is a aggregate operator. It comprises of the following sub-operators: </div>
Copy link
Member

Choose a reason for hiding this comment

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

These are good, we should probably take this wording and apply it to the User Guide pages too

@bparks13
Copy link
Member

bparks13 commented Aug 2, 2024

Looks like the TOC for tutorials needs to be updated and have the lines for the placeholder tutorials removed.

@cjsha
Copy link
Member Author

cjsha commented Aug 2, 2024

The .*DeviceFactory classes were preventing the linkcheck from successfully completing so I included a little if statement that said if the model in question includes DeviceFactory in its uid, toggle off the model.showWorkflow flag

- edit template to use the showWorkflow flag
@cjsha cjsha merged commit a391964 into main Aug 2, 2024
3 checks passed
@cjsha cjsha deleted the monolithic-operator-pages branch August 2, 2024 22:34
@cjsha cjsha restored the monolithic-operator-pages branch August 2, 2024 22:42
@cjsha cjsha deleted the monolithic-operator-pages branch August 8, 2024 23:10
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.

2 participants