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

feat(documentation): Custom help link #6842

Merged
merged 2 commits into from
Apr 15, 2019

Conversation

link108
Copy link
Member

@link108 link108 commented Apr 11, 2019

This enables Spinnaker administrators to add a custom help link. This link can provide organization specific examples / use cases for Spinnaker.

@link108 link108 force-pushed the custom-help-link branch 2 times, most recently from 8c51ad9 to 10854c1 Compare April 12, 2019 02:28
@link108 link108 force-pushed the custom-help-link branch 3 times, most recently from 5e7a2af to 0bc1ee1 Compare April 12, 2019 19:38
<i className={helpLink.icon} /> &nbsp;
</span>
) : null}
{helpLink.text || `Additional Help ${i}`}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{helpLink.text || `Additional Help ${i}`}
{helpLink.text || `Additional Help`}

I would drop the ${i} part here. My guess is, if folks omit the text part of the help, they're only adding a single additional help link, so it would look weird to see Additional Help 0.

@anotherchrisberry
Copy link
Contributor

One really minor thing, LGTM otherwise, thanks!

@link108 link108 force-pushed the custom-help-link branch 2 times, most recently from 8c95f38 to 4806be7 Compare April 15, 2019 19:49
Enable Spinnaker Admins to add a help link to their own docs/examples
@link108
Copy link
Member Author

link108 commented Apr 15, 2019

Thanks for review! Updated @anotherchrisberry 👍

@anotherchrisberry anotherchrisberry merged commit 20d6766 into spinnaker:master Apr 15, 2019
@link108 link108 deleted the custom-help-link branch April 16, 2019 01:05
anotherchrisberry added a commit that referenced this pull request Apr 16, 2019
…85 and titus to 0.0.87 (#6855)

* chore(core): Bump version to 0.0.351

f6c87a3 refactor(core/amazon): allow custom load balancer creation flow (#6852)
6ddc476 fix(titus): correctly set dirty field on command viewstate (#6795)
20d6766 feat(help): Custom help link (#6842)
a9cfe57 chore: upgrade to react 16.8 (#6846)
2e4135a fix(pipeline/executionStatus): "details" link hidden by scrollbar. (#6850)
af8fa5f feat(preconfiguredJobs): support produce artifacts (#6845)
48ba3fc fix(core/pipeline): un-shadow parameter (#6843)
ec12527 feat(core/pipeline): add execution UI for waitForCondition stage (#6826)
e17f387 fix(artifacts): HTTP default artifact needs reference field (#6836)
e618548 feat(preconfiguredJob): logs for k8s jobs (#6840)
6072ee5 feat(core/pipelineConfig): toggle pins individually (#6830)
c25363c fix(artifacts): Clean pipeline expected artifacts when triggers are removed (#6799)
5640431 fix(k8s): Fix deploy manifest (#6833)
2020bf6 feat(core/execution-parameters): condense parameters/artifacts and make it collapsable (#6756)
2d7f388 feat(kubernetes): feature-flagged support for kubernetes traffic management strategies (#6816)
bcca9dc feat(core): Create pipeline from v2 template list
d7e860c fix(triggers): Remove RunAsUser if pipeline permissions enabled for react triggers. (#6818)
1201896 fix(mptv2): clicking a view link on template list screen throws exception (#6815)
985a3ad fix(artifacts): helm artifact, replace object assignw with object spread (#6814)
2039b34 fix(artifacts): default helm artifact editor is broken (#6811)
bdcbc97 fix(google): GCE create server group and load balancer fixes (#6806)

* chore(docker): Bump version to 0.0.36

d7e860c fix(triggers): Remove RunAsUser if pipeline permissions enabled for react triggers. (#6818)

* chore(amazon): Bump version to 0.0.185

f6c87a3 refactor(core/amazon): allow custom load balancer creation flow (#6852)
6ddc476 fix(titus): correctly set dirty field on command viewstate (#6795)

* chore(titus): Bump version to 0.0.87

30556ad fix(titus): send serverGroupName when terminating instances (#6854)
6ddc476 fix(titus): correctly set dirty field on command viewstate (#6795)
@seanpeters86
Copy link
Contributor

@link108 hey there, just curious what the exact format is to add links. I assume it's something like this but I'm not sure:

settings.js:

additionalHelpLinks: [text: "helptext", url: "urlhere", icon: "iconname"]

Also, where do we get the icon names that are available? I'm assuming its some package like font awesome or something but I'm not sure.

@anotherchrisberry
Copy link
Contributor

@seanpeters86 that's pretty close.

additionalHelpLinks: [
  { text: "link description text", url: "urlhere", icon: "fas fa-bullhorn" }
]

Icons can be found here:
https://fontawesome.com/icons?d=gallery&m=free
You'll want to make sure that a) you're getting the free icons and b) you include both of those classes (fa-bullhorn is the icon, fas is a modifier that indicates "solid"). Deck is just rendering an <i> tag with icon as its class, so you need to put the whole thing in there. Click on an icon from that link above and you'll see the HTML for the tag on the details page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants