Commit Graph

32 Commits

Author SHA1 Message Date
kolchfa-aws 1cb5e6e6ff
Add version to the OpenSearch documentation section (#6162)
* Add version to the OpenSearch documentation section

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* List only major and minor version of documentation

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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 <kolchfa@amazon.com>

* Change shadow size

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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 <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Updates footer design and menu items

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Consolidates SCSS mixins and color palette

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Reduce classname verbosity slightly

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Removes redundant mobile menu button handler

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Corects spacing issue

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Corrects nav menu margins

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Corrects header logo clipping

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Updates navigation menu items

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Corrects top level navigation hover states

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adds smoother responsive margins between top navigation header menu items

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Remove deleted SCSS file

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

---------

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>
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 <taoist.futility@pm.me>

* Adds style overrides for search functionality

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adds Font Awesome for menu icons

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adds style overrides and updated menu item configurations

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Removes outdated message about old version release

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Corrects padding, positioning, typography for the site footer

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adds new footer logo

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adds footer link styles

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adjusts page layout to fit the new container width requirements

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Fixes mobile layout with new header and footer

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Fixes mobile navigation menu errors

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adjusts padding

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Removes commented out code

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Updates top navigation menu items with latest from project site

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

---------

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>
Signed-off-by: astephanus <124592019+astephanus@users.noreply.github.com>
2023-11-07 15:17:05 -08:00
kolchfa-aws b5ed6c7b1b
Add forum page click to GA (#5458)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
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 <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* 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 <taoist.futility@pm.me>

* Adds arrow up/down key support to toc navigation

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adds missing accessibility attribute handling to the toc

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Corrects arrow key handling of keyboard navigation of the toc

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Adds padding to allow for the keyboard focus rectangle

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Removes explicit tabindex values for the toc navigation

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* 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 <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Corrects navigation item spacing to permit visible focus rectangles

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* 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 <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* Corrects Jekyll include parameter assignment syntax error

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

* 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 <taoist.futility@pm.me>

* 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 <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

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

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>

---------

Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>
2023-07-17 10:11:42 -07:00
Chris Moore 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 <cwmmoore@amazon.com>

* fix#618 saml example download

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#618 saml example download

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#618 saml example download

Signed-off-by: cwillum <cwmmoore@amazon.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-07-06 16:59:26 -05:00
Miki 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 <miki@amazon.com>

* Add archived versions

* Update versions.json

* Add archived versions for version selector.tpl

* Switch back to old versions

---------

Signed-off-by: Miki <miki@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-05-04 16:36:13 -05:00
kolchfa-aws 38eb7f858a
Split comments into parts (#3082)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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 <jeffhuss@amazon.com>

* Fixed uniformity of spacing for heredocs EOF

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Fixed spelling in a comment.

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

---------

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
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 <kolchfa@amazon.com>

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

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds remaining character counter

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Send one event

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Addressed code review and added new banner

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* More code review feedback

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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 <kolchfa@amazon.com>

* Makes adjustments for phone screens

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds background image to banner

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds background to image

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Added centering

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Lower contrast image

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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 <kolchfa@amazon.com>

* Changed localStorage to sessionStorage

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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 <kolchfa@amazon.com>

* Addresses code review feedback, removes feedback

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds back feedback mechanism

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Makes back to top button non-transparent

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Small change in style

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds margin to copy button wrap

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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 <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
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 <kolchfa@amazon.com>

* Makes sidebar sticky

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Gives more real estate to the main pane

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds copy button

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds copy button to code snippets

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds copy as curl

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Moved copy buttons to the bottom right of snippets

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Moved edit page footer to the bottom of the page

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Implemented scrolling to the active link in navbar on reload

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Adds feedback buttons

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-12-02 12:03:46 -05:00
Jeff Huss 0d488028c6
Adds a quickstart guide (#1739)
* Beginning quickstart guide

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Add sample docker compose yaml to assets

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding verbiage about compose commands

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* More additions but saving before a lunch break

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

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

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added first common problem

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

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

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Formatting

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

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

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Indentation

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added common issue re: docker perms

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

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

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

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

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Updates

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Committing changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

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

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Adding steps

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added cURL command for example query

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Reworded intro paragraph and added more steps.

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added tip about using the pretty query parameter

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editing

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Added dashboards content and working on next steps segue

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Wrapping up for the day

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Cleaning up before reviews

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Finishing up

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Editorial fixes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Final editorial changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Changes relating to PM review

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Incorporating feedback from docs review

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Final changes

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
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 <jeffhuss@amazon.com>

* Fixed index file for bulk API syntax

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
2022-11-21 12:25:29 -08:00
Chris Moore 5557a80f61
fix#905-ldap-zip-mv (#1760)
Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>
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 <miki@amazon.com>
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 <mehranb@amazon.com>
2021-12-03 16:15:28 -08:00
Miki 5a0812221f
Enhance breadcrumbs and URLs in search results
Signed-off-by: Miki <mehranb@amazon.com>
2021-12-03 12:57:28 -08:00
Miki e60bbafd91
Add custom search
Signed-off-by: Miki <mehranb@amazon.com>
2021-11-29 18:49:04 -08:00
Miki ddcec72c2a Fix versions selection being blocked on mobile devices
Signed-off-by: Miki <mehranb@amazon.com>
2021-10-07 10:29:33 -07:00
Miki 03e3fce37f Add `.x` suffix to versions selector
Signed-off-by: Miki <mehranb@amazon.com>
2021-10-06 09:53:15 -07:00
Miki 31003b1523 Add versioned documentation
Reduce font size and expand width

Signed-off-by: Miki <mehranb@amazon.com>
2021-10-05 10:48:07 -07:00
aetter 65d2ef4860 Re-add SAML example 2021-09-29 09:29:41 -07:00
aetter d4c20f0402 Re-add LDAP Docker example
Update Docker Compose file
2021-09-28 15:33:48 -07:00
Miki 96f2dbafdf Unify look and feel with project website
Signed-off-by: Miki <mehranb@amazon.com>
2021-07-12 14:14:40 -07:00
aetter 77eddb18cc It's a real logo 2021-05-07 09:57:01 -07:00
aetter 4c7109366d Initial documentation cut 2021-05-05 10:09:47 -07:00