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

Doc: Implement install widgets with platform tabs #12850

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

karenzone
Copy link
Contributor

@karenzone karenzone commented Apr 23, 2021

Release notes

[rn:skip]

What does this PR do?

Adds tab widget infrastructure
Breaks up walls of text by adding tabbed widgets to show installation instructions per platform

PREVIEW: https://logstash_12850.docs-preview.app.elstc.co/guide/en/logstash/master/installing-logstash.html
Check out the DEB x86_64 tab for a sample of what both DEB platform install instructions might look like under one tab.

IMPORTANT: This work is still in the design/experimental phase, and install content is not accurate.

ToDO:

  • Finalize content
  • Remove components used for local testing:
    • widgets code file (as indicated here)
    • hard-coded "released" setting that makes it possible to test content

@karenzone
Copy link
Contributor Author

karenzone commented Apr 24, 2021

Status: 2021-0423

Added test scenario under deb-x86_64 tab. (Test scenario must be backed out before this PR can be merged.)

Next steps (notes to self @karenzone ):

  • Get input on combining x86_64 and AARCH64 for each platform under one tab (LINUX, DEB, RPM, etc.) to shorten tab names and prevent ugly wrap scenario.

Screen Shot 2021-04-23 at 8 12 48 PM

  • Remember that selected platform persists. Grouping x86_64 and AARCH64 under one platform tab heading (Linux, DEB, RPM, etc.) might not be ideal for long text blocks (if we have a need for those). But the long, wrapping tab row isn't ideal either.

Screen Shot 2021-04-23 at 8 10 24 PM

@karenzone
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

1 similar comment
@karenzone
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

@karenzone
Copy link
Contributor Author

jenkins test this please

@gtback
Copy link
Member

gtback commented Jun 29, 2021

@elasticmachine run elasticsearch-ci/docs

@gtback gtback marked this pull request as ready for review June 29, 2021 19:52
@gtback
Copy link
Member

gtback commented Jun 29, 2021

@elasticmachine run elasticsearch-ci/docs

@gtback gtback marked this pull request as draft June 29, 2021 19:53
@gtback
Copy link
Member

gtback commented Jun 29, 2021

@elasticmachine run elasticsearch-ci/docs

@karenzone
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

@@ -0,0 +1,166 @@
// Defining styles and script here for simplicity.
++++
Copy link
Contributor Author

Choose a reason for hiding this comment

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

ToDo: Figure out which tab should be the default selection, and set it.

Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need to include this anymore since as of elastic/docs#2180, this is included in the doc build itself and doesn't need to be in each repo that uses the tab widgets.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

NOTED for future action. Thanks for the info. While I'm still developing content, it's handy to be able to fire off local builds for quickie testing.

I'll remove the file before I finalize this PR.

Copy link
Member

Choose a reason for hiding this comment

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

Sounds great, let me know if I can help at all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants