Skip to content

Add new landing page CSS to this repo #2548

Open
@colleenmcginnis

Description

@colleenmcginnis

Overview

In elastic/kibana#138051 @gchaps created a new landing page for the Kibana docs. There's some interest in using a similar layout for other docs (for example, elastic/observability-docs#2209).

Most of the styling for the page uses either (1) Bootstrap CSS (see gchaps/kibana#1) or (2) global styles defined in this repo. However, there are a few custom style classes needed to structure the page. Currently those classes are included in the HTML directly inside <style> tags.

We should move these landing page specific styles to this repo to make it easier to maintain consistency especially if we plan to build similar pages for other books. But, I'm hesitant to move those styles to this repo before publishing this landing page because of the issues we saw with caching of front-end assets that caused many users to be served a mix of old and new HTML/CSS/JS when we published #2478 (for example, #2510). I think we should figure out a cache-busting strategy for front-end assets (perhaps #2509) before moving the landing page styles to this repo.

In the short term, @ryankeairns @gchaps and I decided it would be ok to publish elastic/kibana#138051 with the custom styles included in the HTML in the /kibana repo. I think this would help us avoid the caching issues because the styles will be in a new file (rather than changes in an existing repo).

Next steps

  • Publish [DOCS] Redesigns Kibana docs landing page kibana#138051 with styles included in the HTML
  • Figure out a cache-busting strategy for front-end assets
  • Add landing page styles to /docs
  • Remove landing page styles from /kibana
  • Other teams build landing pages using global styles as needed

cc @ryankeairns @gchaps @gtback @bmorelli25

Metadata

Metadata

Assignees

No one assigned

    Labels

    designVisual appearance of the built documentationenhancementSomething we'd like to improve

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions