35 Commits
Author SHA1 Message Date
Darshit Chanpura e476ee8db9 Updates SAML demo setup documentation (#6532)
* Updates SAML demo setup documentation

Signed-off-by: Darshit Chanpura <[email protected]>

* Updates some language around steps

Signed-off-by: Darshit Chanpura <[email protected]>

* Deleted old saml zip

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes vale errors

Signed-off-by: Darshit Chanpura <[email protected]>

* Fixes style check

Signed-off-by: Darshit Chanpura <[email protected]>

* Address PR feedback

Signed-off-by: Darshit Chanpura <[email protected]>

* Addresses more comments

Signed-off-by: Darshit Chanpura <[email protected]>

* Adds onboarding as part of vocab

Signed-off-by: Darshit Chanpura <[email protected]>

* Changes the sentence phrase

Signed-off-by: Darshit Chanpura <[email protected]>

* Addresses more feedback

Signed-off-by: Darshit Chanpura <[email protected]>

---------

Signed-off-by: Darshit Chanpura <[email protected]>
2024-03-01 08:44:29 -08:00
150101bce3 Adds documentation for security demo configuration setup (#6058)
* Adds documentation for security demo configuration setup

Signed-off-by: Darshit Chanpura <[email protected]>

* Removes hardcoded version numbers

Signed-off-by: Darshit Chanpura <[email protected]>

* Updates distributions for different documentations

Signed-off-by: Darshit Chanpura <[email protected]>

* Renames placeholder

Signed-off-by: Darshit Chanpura <[email protected]>

* Resolves some vale errors

Signed-off-by: Darshit Chanpura <[email protected]>

* Resolves some more vale warnings

Signed-off-by: Darshit Chanpura <[email protected]>

* Updates sample docker compose wordings

Signed-off-by: Darshit Chanpura <[email protected]>

* Improves wordings

Signed-off-by: Darshit Chanpura <[email protected]>

* Changes the demo config page title

Signed-off-by: Darshit Chanpura <[email protected]>

* Address PR comments

Signed-off-by: Darshit Chanpura <[email protected]>

* Renames admin password placeholder and updates another sentence

Signed-off-by: Darshit Chanpura <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Darshit Chanpura <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2024-02-01 10:00:23 -08:00
kolchfa-aws 72c0ed10af Refactor home page layout (#6307)
* Refactor home page layout

Signed-off-by: Fanit Kolchina <[email protected]>

* Remove hover from last link

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
2024-01-31 11:54:59 -05:00
kolchfa-aws 1cb5e6e6ff Add version to the OpenSearch documentation section (#6162)
* Add version to the OpenSearch documentation section

Signed-off-by: Fanit Kolchina <[email protected]>

* List only major and minor version of documentation

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
2024-01-16 20:28:46 -05:00
kolchfa-aws e7fc10885c Add shadow to version selector panel when left nav is scrolled (#6151)
* Add shadow to version selector panel when scrolling

Signed-off-by: Fanit Kolchina <[email protected]>

* Change shadow size

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
2024-01-16 13:11:25 -05:00
astephanus ad8df5c9ad Redesigned header / footer integration copied from project site. (#5702)
* Adds remote loading of header component from project site

Signed-off-by: Aaron Stephanus <[email protected]>

* Integrates the redesigned header; removes the old copy-banner and search field

Signed-off-by: Aaron Stephanus <[email protected]>

* Updates footer design and menu items

Signed-off-by: Aaron Stephanus <[email protected]>

* Consolidates SCSS mixins and color palette

Signed-off-by: Aaron Stephanus <[email protected]>

* Reduce classname verbosity slightly

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes redundant mobile menu button handler

Signed-off-by: Aaron Stephanus <[email protected]>

* Corects spacing issue

Signed-off-by: Aaron Stephanus <[email protected]>

* Corrects nav menu margins

Signed-off-by: Aaron Stephanus <[email protected]>

* Corrects header logo clipping

Signed-off-by: Aaron Stephanus <[email protected]>

* Updates navigation menu items

Signed-off-by: Aaron Stephanus <[email protected]>

* Corrects top level navigation hover states

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds smoother responsive margins between top navigation header menu items

Signed-off-by: Aaron Stephanus <[email protected]>

* Remove deleted SCSS file

Signed-off-by: Aaron Stephanus <[email protected]>

---------

Signed-off-by: Aaron Stephanus <[email protected]>
2023-12-12 15:59:47 -08:00
Naarcha-AWS 1d1c1bb0e3 Revert "Redesigned top nav and footer (#5113)" (#5560)
This reverts commit dadb6b1f14.
2023-11-09 14:25:32 -06:00
astephanus dadb6b1f14 Redesigned top nav and footer (#5113)
* Ports over redesigned top banner header navigation, and footer

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds style overrides for search functionality

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds Font Awesome for menu icons

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds style overrides and updated menu item configurations

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds whitespace to fix SASS style rule causing Github action failure

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds dynamic navigation submenu height determination for smooth expand/collapse transitions instead of hardcoded values potentiating effortless change management

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes outdated message about old version release

Signed-off-by: Aaron Stephanus <[email protected]>

* Corrects padding, positioning, typography for the site footer

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds new footer logo

Signed-off-by: Aaron Stephanus <[email protected]>

* Sets footer legal copy right padding on mobile to that of the scroll-to-top button

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds footer link styles

Signed-off-by: Aaron Stephanus <[email protected]>

* Adjusts page layout to fit the new container width requirements

Signed-off-by: Aaron Stephanus <[email protected]>

* Fixes mobile layout with new header and footer

Signed-off-by: Aaron Stephanus <[email protected]>

* Fixes mobile navigation menu errors

Signed-off-by: Aaron Stephanus <[email protected]>

* Adjusts padding

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes commented out code

Signed-off-by: Aaron Stephanus <[email protected]>

* Updates top navigation menu items with latest from project site

Signed-off-by: Aaron Stephanus <[email protected]>

---------

Signed-off-by: Aaron Stephanus <[email protected]>
Signed-off-by: astephanus <[email protected]>
2023-11-07 15:17:05 -08:00
kolchfa-aws b5ed6c7b1b Add forum page click to GA (#5458)
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
2023-10-31 15:29:28 -04:00
astephanus 80237e2e68 Toc keyboard navigation (#4497)
* Adds keyboard navigation to table of content links

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds table of contents scroll and item focus management to the current page or the first toc item

Signed-off-by: Aaron Stephanus <[email protected]>

* Add space key capture to the toc expand/collapse arrows

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds escape key support for expand/collapse of toc categories on the category label

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds missing aria-role and aria-current attributes to toc affordances

Signed-off-by: Aaron Stephanus <[email protected]>

* Changes the function of the space bar to navigate to a toc parent category item instead of only expand its children

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds arrow up/down key support to toc navigation

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds missing accessibility attribute handling to the toc

Signed-off-by: Aaron Stephanus <[email protected]>

* Corrects arrow key handling of keyboard navigation of the toc

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds padding to allow for the keyboard focus rectangle

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes explicit tabindex values for the toc navigation

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes auto focus of toc navigation items on page load; refactors navigation panel scroll into view logic to account for the sticky version selector

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes keyboard focus trap on search field for the tab key

Signed-off-by: Aaron Stephanus <[email protected]>

* Unifies navigation item focus state for top level items and sub navigation items

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes the expand/collapse navigation buttons from being tab focusable

Signed-off-by: Aaron Stephanus <[email protected]>

* Corrects navigation item spacing to permit visible focus rectangles

Signed-off-by: Aaron Stephanus <[email protected]>

* Implements full arrow navigation for the toc items according to the w3c tree view navigation pattern

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds reference link to the w3c documentation about the tree view navigation to the arrow key toc navigation javascript

Signed-off-by: Aaron Stephanus <[email protected]>

* Account for the difference between the navigation panel height, and the viewport height when auto scrolling the toc item of the current page

Signed-off-by: Aaron Stephanus <[email protected]>

* Corrects keyboard navigation focus rectangles from being slightly obscured on the bottom

Signed-off-by: Aaron Stephanus <[email protected]>

* Corrects aria and role attributes according to the navigation tree pattern as opposed to the disclosure pattern

Signed-off-by: Aaron Stephanus <[email protected]>

* Corrects Jekyll include parameter assignment syntax error

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes aria-expanded setting from the templates since it is unrealiable to determine without iterating through the entire tree to determine if one of its children of children is the current page

Signed-off-by: Aaron Stephanus <[email protected]>

* Moves setting of aria-expanded attributes to a runtime behavior, and corrects arrow left/right behavior on navigation tree items

Signed-off-by: Aaron Stephanus <[email protected]>

* Ensures unique navigation menu element ids; conditionally sets aira-owns and aria-current attributes

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes JavaScript that is unused following refactoring tree view navigation; adds comments explaining choices

Signed-off-by: Aaron Stephanus <[email protected]>

---------

Signed-off-by: Aaron Stephanus <[email protected]>
2023-07-17 10:11:42 -07:00
Chris MooreandNaarcha-AWS 07c4019e33 Add new zip for example SAML configuration files that reflect latest version (#3665)
* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
2023-07-06 16:59:26 -05:00
MikiandNaarcha-AWS 271a98d669 Allow limiting the versions shown by default in the version-selector (#3773)
* Allow limiting the versions shown by default in the `version-selector`

Signed-off-by: Miki <[email protected]>

* Add archived versions

* Update versions.json

* Add archived versions for version selector.tpl

* Switch back to old versions

---------

Signed-off-by: Miki <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
2023-05-04 16:36:13 -05:00
kolchfa-aws 38eb7f858a Split comments into parts (#3082)
Signed-off-by: Fanit Kolchina <[email protected]>
2023-02-28 15:18:02 -05:00
Jeff Huss e0c722cdf1 Add example Docker deployment script for upgrade testing and validation (#3070)
* Add example Docker deployment script for upgrade testing and validation

Signed-off-by: JeffH-AWS <[email protected]>

* Fixed uniformity of spacing for heredocs EOF

Signed-off-by: JeffH-AWS <[email protected]>

* Fixed spelling in a comment.

Signed-off-by: JeffH-AWS <[email protected]>

---------

Signed-off-by: JeffH-AWS <[email protected]>
2023-02-24 12:56:54 -08:00
kolchfa-aws 48e1e654d6 Add comment field to feedback panel (#2941)
* Add text area for comments to feedback panel

Signed-off-by: Fanit Kolchina <[email protected]>

* Added radio buttons, sending comments to GA, and refactored scss

Signed-off-by: Fanit Kolchina <[email protected]>

* Adds remaining character counter

Signed-off-by: Fanit Kolchina <[email protected]>

* Send one event

Signed-off-by: Fanit Kolchina <[email protected]>

* Addressed code review and added new banner

Signed-off-by: Fanit Kolchina <[email protected]>

* More code review feedback

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
2023-02-17 16:59:59 -05:00
kolchfa-aws 1722da6337 Adds documentation site banner (#2544)
* Adds documentation site banner

Signed-off-by: Fanit Kolchina <[email protected]>

* Makes adjustments for phone screens

Signed-off-by: Fanit Kolchina <[email protected]>

* Adds background image to banner

Signed-off-by: Fanit Kolchina <[email protected]>

* Adds background to image

Signed-off-by: Fanit Kolchina <[email protected]>

* Added centering

Signed-off-by: Fanit Kolchina <[email protected]>

* Lower contrast image

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
2023-02-10 13:22:55 -05:00
kolchfa-aws 8565bb2adf Scroll to top when last visit was more than 24 hours ago (#2457)
* Scroll to top when last visit was more than 24 hours ago

Signed-off-by: Fanit Kolchina <[email protected]>

* Changed localStorage to sessionStorage

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
2023-01-26 11:14:26 -05:00
kolchfa-aws 10e0c5de7c Updates site UI changes (#2264)
* Updates site UI changes

Signed-off-by: Fanit Kolchina <[email protected]>

* Addresses code review feedback, removes feedback

Signed-off-by: Fanit Kolchina <[email protected]>

* Adds back feedback mechanism

Signed-off-by: Fanit Kolchina <[email protected]>

* Makes back to top button non-transparent

Signed-off-by: Fanit Kolchina <[email protected]>

* Small change in style

Signed-off-by: Fanit Kolchina <[email protected]>

* Adds margin to copy button wrap

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
2022-12-27 11:45:32 -05:00
kolchfa-aws 0402d132dd Adds feedback mechanism and more site visual improvements (#2259)
Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
2022-12-19 14:41:42 -05:00
kolchfa-aws 307790470c Adds documentation site changes (sticky nav, copy button, back to top button) (#2043)
* Adds back to top button

Signed-off-by: Fanit Kolchina <[email protected]>

* Makes sidebar sticky

Signed-off-by: Fanit Kolchina <[email protected]>

* Gives more real estate to the main pane

Signed-off-by: Fanit Kolchina <[email protected]>

* Adds copy button

Signed-off-by: Fanit Kolchina <[email protected]>

* Adds copy button to code snippets

Signed-off-by: Fanit Kolchina <[email protected]>

* Adds copy as curl

Signed-off-by: Fanit Kolchina <[email protected]>

* Moved copy buttons to the bottom right of snippets

Signed-off-by: Fanit Kolchina <[email protected]>

* Moved edit page footer to the bottom of the page

Signed-off-by: Fanit Kolchina <[email protected]>

* Implemented scrolling to the active link in navbar on reload

Signed-off-by: Fanit Kolchina <[email protected]>

* Adds feedback buttons

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>
2022-12-02 12:03:46 -05:00
Jeff Huss 0d488028c6 Adds a quickstart guide (#1739)
* Beginning quickstart guide

Signed-off-by: JeffH-AWS <[email protected]>

* Add sample docker compose yaml to assets

Signed-off-by: JeffH-AWS <[email protected]>

* Adding verbiage about compose commands

Signed-off-by: JeffH-AWS <[email protected]>

* More additions but saving before a lunch break

Signed-off-by: JeffH-AWS <[email protected]>

* Remove sample compose file from the quickstart guide since it is linked externally

Signed-off-by: JeffH-AWS <[email protected]>

* Added first common problem

Signed-off-by: JeffH-AWS <[email protected]>

* Formatting of common issues - oh and I renamed it common issues because problems sounds too negative

Signed-off-by: JeffH-AWS <[email protected]>

* Formatting

Signed-off-by: JeffH-AWS <[email protected]>

* Adding more content. I love Starbucks White Chocolate Mocha creamer

Signed-off-by: JeffH-AWS <[email protected]>

* Indentation

Signed-off-by: JeffH-AWS <[email protected]>

* Added common issue re: docker perms

Signed-off-by: JeffH-AWS <[email protected]>

* Changing the common issues section around a bit so the ordering makes more sense

Signed-off-by: JeffH-AWS <[email protected]>

* Removed blank target from important settings links since we don't do that for other links

Signed-off-by: JeffH-AWS <[email protected]>

* Updates

Signed-off-by: JeffH-AWS <[email protected]>

* Committing changes

Signed-off-by: JeffH-AWS <[email protected]>

* Added newline to docker compose file and started working on steps in the guide

Signed-off-by: JeffH-AWS <[email protected]>

* Adding steps

Signed-off-by: JeffH-AWS <[email protected]>

* Added cURL command for example query

Signed-off-by: JeffH-AWS <[email protected]>

* Reworded intro paragraph and added more steps.

Signed-off-by: JeffH-AWS <[email protected]>

* Added tip about using the pretty query parameter

Signed-off-by: JeffH-AWS <[email protected]>

* Editing

Signed-off-by: JeffH-AWS <[email protected]>

* Added dashboards content and working on next steps segue

Signed-off-by: JeffH-AWS <[email protected]>

* Wrapping up for the day

Signed-off-by: JeffH-AWS <[email protected]>

* Cleaning up before reviews

Signed-off-by: JeffH-AWS <[email protected]>

* Finishing up

Signed-off-by: JeffH-AWS <[email protected]>

* Editorial fixes

Signed-off-by: JeffH-AWS <[email protected]>

* Final editorial changes

Signed-off-by: JeffH-AWS <[email protected]>

* Changes relating to PM review

Signed-off-by: JeffH-AWS <[email protected]>

* Incorporating feedback from docs review

Signed-off-by: JeffH-AWS <[email protected]>

* Final changes

Signed-off-by: JeffH-AWS <[email protected]>

Signed-off-by: JeffH-AWS <[email protected]>
2022-11-23 10:58:00 -08:00
Jeff Huss 483ba35282 Adds sample data set to the repo for use in quick start guide (#1995)
* Added ecommerce index and field mappings to exampl dir in github

Signed-off-by: JeffH-AWS <[email protected]>

* Fixed index file for bulk API syntax

Signed-off-by: JeffH-AWS <[email protected]>

Signed-off-by: JeffH-AWS <[email protected]>
2022-11-21 12:25:29 -08:00
Chris Moore 5557a80f61 fix#905-ldap-zip-mv (#1760)
Signed-off-by: cwillum <[email protected]>

Signed-off-by: cwillum <[email protected]>
2022-10-31 08:04:29 -07:00
Miki d2646bb3f3 Allow latest version not to be the current version of the documentation
Signed-off-by: Miki <[email protected]>
2022-05-03 11:34:40 -07:00
Miki 4001b3c334 Fix version-selector in Safari 15.x
Some browser+OS combinations trigger `blur` on the version-selector before a click within the component. To mitigate this, an extra `pointerup` listener was attached but that didn't solve the problem for Safari 15.x. However, `delegatesFocus: true` makes the shadow host focusable and that helps work around this problem.

Fixes: #307
Signed-off-by: Miki <[email protected]>
2021-12-03 16:15:28 -08:00
Miki 5a0812221f Enhance breadcrumbs and URLs in search results
Signed-off-by: Miki <[email protected]>
2021-12-03 12:57:28 -08:00
Miki e60bbafd91 Add custom search
Signed-off-by: Miki <[email protected]>
2021-11-29 18:49:04 -08:00
Miki ddcec72c2a Fix versions selection being blocked on mobile devices
Signed-off-by: Miki <[email protected]>
2021-10-07 10:29:33 -07:00
Miki 03e3fce37f Add .x suffix to versions selector
Signed-off-by: Miki <[email protected]>
2021-10-06 09:53:15 -07:00
Miki 31003b1523 Add versioned documentation
Reduce font size and expand width

Signed-off-by: Miki <[email protected]>
2021-10-05 10:48:07 -07:00