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

Fix beta doc links, truncated help menu label #382

Merged
merged 2 commits into from
May 26, 2021

Conversation

tmarkley
Copy link
Contributor

@tmarkley tmarkley commented May 26, 2021

Signed-off-by: Tommy Markley markleyt@amazon.com

Description

This doesn't fix all links because not all pages exist in the beta docs site. This is a stopgap for the 1.0 release. The following links are addressed:

  • Main documentation link from the help menu
  • DQL link
  • Aggregation help links
  • Removes the 'kibana' reference from the remaining broken links

The help menu label for the "OpenSearch Dashboards documentation" option was truncated but that was fixed by expanding the width.

help menu

Issues Resolved

Addresses some of the links that need to be fixed for #335

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

… label isn't truncated

Signed-off-by: Tommy Markley <markleyt@amazon.com>
@tmarkley tmarkley added the bug Something isn't working label May 26, 2021
@tmarkley tmarkley requested review from ananzh and kavilla May 26, 2021 21:33
@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed 5bfc5cb

@@ -126,16 +127,16 @@ export class DocLinksService {
introduction: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/index-patterns.html`,
},
addData: `${OPENSEARCH_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/connect-to-elasticsearch.html`,
Copy link
Member

Choose a reason for hiding this comment

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

do we want to replaced the "kibana" reference or just delete it to remove the reference or should we verify first if it's fine to leave the word kibana in?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I can just remove the reference for now.

ananzh
ananzh previously approved these changes May 26, 2021
Signed-off-by: Tommy Markley <markleyt@amazon.com>
@opensearch-ci-bot
Copy link
Collaborator

✅   DCO Check Passed b0691c7

@tmarkley tmarkley requested review from ananzh and kavilla May 26, 2021 22:45
@tmarkley tmarkley changed the title Fix dashboards documentation and DQL links, truncated help menu label Fix beta doc links, truncated help menu label May 26, 2021
Copy link
Member

@ananzh ananzh left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@kavilla kavilla left a comment

Choose a reason for hiding this comment

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

Awesome LGTM! We will need to replace these will actual values in the future once we have a substitute.

@kavilla kavilla merged commit 1856d48 into opensearch-project:main May 26, 2021
kavilla pushed a commit that referenced this pull request May 26, 2021
* Fix dashboards documentation and DQL links, expand help menu width so label isn't truncated

Signed-off-by: Tommy Markley <markleyt@amazon.com>

* Remove kibana references from doc links, fix aggregation links

Signed-off-by: Tommy Markley <markleyt@amazon.com>
@tmarkley tmarkley deleted the osd-335 branch May 26, 2021 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants