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

[DOCS] Redesigns Kibana docs landing page #138051

Merged
merged 20 commits into from
Oct 26, 2022

Conversation

gchaps
Copy link
Contributor

@gchaps gchaps commented Aug 3, 2022

Summary

This PR tries out a new design for the Kibana docs landing page.

Preview:
https://kibana_138051.docs-preview.app.elstc.co/guide/en/kibana/master/index.html


<div class="row my-4">
<div class="col-md-6 col-12">
<p>
Copy link
Contributor

@ryankeairns ryankeairns Aug 26, 2022

Choose a reason for hiding this comment

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

I would add an <h2>Subtitle</h2>. This is partially for visual purposes as it will decrease the amount of whitespace alongside that top image. Also, these heading tags are navigable with assistive technology.

<div class="col-md-4 col-12 mb-2">
<a class="no-text-decoration" href="dashboard.html">
<div class="card">
<p class="font-weight-bold">Add search experience</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

These card titles ought to be <h3> or <h4> instead of <p>

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, you could add solution icons/logos above each card title

<div class="my-5">
<div class="d-flex align-items-center mb-3">
<div class="icon" style="background-image: url('https://i.imgur.com/e8Zu260.png');"></div>
<div class="section-title">Explore, visualize, and share</div>
Copy link
Contributor

Choose a reason for hiding this comment

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

I would expect these to be <h3> as opposed to <div...>
You could still do <h3 class="section-title"> although I wonder if there are some existing styles that will get applied even without that class being included.

}

body {
font-family: Arial, Helvetica, sans-serif;
Copy link
Contributor

Choose a reason for hiding this comment

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

You can remove this. We user Inter which is already set, globally.

background-repeat: no-repeat;
}

.section-title {
Copy link
Contributor

Choose a reason for hiding this comment

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

You should be able to remove these overrides after switching to heading tags <h1>, <h2>..., etc

@@ -0,0 +1,222 @@
<style>
Copy link
Contributor

Choose a reason for hiding this comment

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

Before we merge this, let's chat about global styles. The end result of this page looks nice, visually, but we need to handle these styles in a way that maintains consistency. Good start here!

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes! I also just talked with @elastic/obs-docs about this and we're interested in doing something similar for the Observability docs so it might be good to move any custom CSS in this PR out of /kibana into /docs. 🙂

<div class="card">
<div class="icon" style="background-image: url('https://i.imgur.com/XCIZjs1.png');"></div>
<h4>Observe</h4>
<p class="card-description">Follow our guides for monitoring logs, metrics, and traces.</p>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@colleenmcginnis Can you please review the link and text for the Observability card?

Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

Nice design! One possible tweak to the "Protect" card.

<div class="card">
<div class="icon" align-items-center style="background-image: url('https://i.imgur.com/MNgoZfx.png');"></div>
<h4>Protect</h4>
<p class="card-description">Everything you need to know about protecting your data.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

"Everything you need to know about" seems a bit wordy, and we could use the space for more focused terminology. This revision borrows some phrasing from the app description on the UI's Home page:

Suggested change
<p class="card-description">Everything you need to know about protecting your data.</p>
<p class="card-description">Learn how to protect your data and respond to threats across your infrastructure.</p>

image

@gchaps
Copy link
Contributor Author

gchaps commented Sep 20, 2022

@elasticmachine merge upstream

Copy link
Contributor

@ryankeairns ryankeairns left a comment

Choose a reason for hiding this comment

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

Thanks for the changes. As discussed, let's track the use of <styles> and move these to a global space once the CSS caching is resolved.

Copy link
Contributor

@kellyemurphy kellyemurphy left a comment

Choose a reason for hiding this comment

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

Just some small tweaks to the cards, to be closer to the current onboarding text.

General question, are we going to add any text somewhere that explains what Kibana is?

docs/index-custom-title-page.html Outdated Show resolved Hide resolved
docs/index-custom-title-page.html Outdated Show resolved Hide resolved
docs/index-custom-title-page.html Outdated Show resolved Hide resolved
gchaps and others added 3 commits October 25, 2022 15:14
Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>
Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>
Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>
@gchaps gchaps marked this pull request as ready for review October 26, 2022 20:04
@gchaps gchaps changed the title [DOCS] Another landing page design--DO NOT MERGE [DOCS] Redesigns Kibana docs landing page Oct 26, 2022
@gchaps gchaps added Team:Docs release_note:skip Skip the PR/issue when compiling release notes v8.5.0 v8.6.0 labels Oct 26, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@gchaps gchaps merged commit 5d2b2e5 into elastic:main Oct 26, 2022
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 26, 2022
* [DOCS] Another landing page design

* [DOCS] Uses cards in landing page

* [DOCS] Updates list of docs

* [DOCS] Emphasizes solutions

* html, css updates

use one column on medium screens and smaller

clean up

clean up again

* [DOCS] Incorporates review comments

* [DOCS] Updates text and link for search

* format headings in cards, ensure cards are always the same height

* remove unused css, align images

* [DOCS] Fixes links to images

* [DOCS] Uses images with transparent background

* Fixes wording in cards

* Update docs/index-custom-title-page.html

Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>

* Update docs/index-custom-title-page.html

Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>

* Update docs/index-custom-title-page.html

Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>

* [DOCS] Add content to describe Kibana

* [DOCS] Minor edits

* Update docs/index-custom-title-page.html

Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>

* [DOCS] Copy edits to landing page

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>
(cherry picked from commit 5d2b2e5)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.5

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Oct 26, 2022
* [DOCS] Another landing page design

* [DOCS] Uses cards in landing page

* [DOCS] Updates list of docs

* [DOCS] Emphasizes solutions

* html, css updates

use one column on medium screens and smaller

clean up

clean up again

* [DOCS] Incorporates review comments

* [DOCS] Updates text and link for search

* format headings in cards, ensure cards are always the same height

* remove unused css, align images

* [DOCS] Fixes links to images

* [DOCS] Uses images with transparent background

* Fixes wording in cards

* Update docs/index-custom-title-page.html

Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>

* Update docs/index-custom-title-page.html

Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>

* Update docs/index-custom-title-page.html

Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>

* [DOCS] Add content to describe Kibana

* [DOCS] Minor edits

* Update docs/index-custom-title-page.html

Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>

* [DOCS] Copy edits to landing page

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
Co-authored-by: Kelly Murphy <kelly.murphy@elastic.co>
(cherry picked from commit 5d2b2e5)

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.5.0 v8.6.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants