search

blackbaud / skyux2-docs

Documentation for SKY UX Components
4 stars 32 forks source link

Missing searchUrl from possible omnibar config #987

Closed Blackbaud-ColbyWhite closed 3 years ago

Blackbaud-ColbyWhite commented 4 years ago

Neither the omnibar docs nor the global nav inidicate what that a omnibar.nav.services.searchUrl is possible in skyuxconfig.json. it also seems that in non-stache cases, the preferred method is through skyux-ia. the yamls in skyux-ia is also not doc'd i believe, but i'm guessing based on quick skimming them in the past that some subset of the skyuxconfig.json is what the yamls want, j/ in yaml form.

slack thread that prompted this.

also, i didnt investigate enough to determine if searchUrl was the only thing missing.

Blackbaud-SteveBrush commented 4 years ago

Closing. We want to keep this as an "undocumented feature" since it's primarily used internal-only.

Blackbaud-ColbyWhite commented 4 years ago

@Blackbaud-SteveBrush , this does not address the ticket. I am internal and it's difficult for me to understand how to use this feature or even know that it's there. and the omnibar-docs seem to be behind auth. i dont have opinion on how to doc this, but the ticket is about the fact that it's not doc'd.

blackbaud-johnly commented 4 years ago

@Blackbaud-TerryHelems and I talked over this, and we came up with a plan to tweak the existing docs to better handle this. A lot of it is just linking to the IA repo's readme from appropriate places. I'm reopening this issue to make those changes.

blackbaud-johnly commented 3 years ago

Closing in favor of https://blackbaud.visualstudio.com/Products/_workitems/edit/1564681 so that we can track this in ADO instead of GitHub. I'll link from that bug to this closed issue for reference.