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

Use documentation link service for security links #87409

Merged
merged 3 commits into from
Jan 12, 2021

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 5, 2021

Summary

This PR updates hard-coded links to security documentation such that they use the documentation link service instead, which is easier to maintain.


constructor(docLinks: DocLinksStart) {
this.esDocBasePath = `${docLinks.ELASTIC_WEBSITE_URL}guide/en/elasticsearch/reference/${docLinks.DOC_LINK_VERSION}/`;
this.apiKeySettings = `${docLinks.links.security.apiKeyServiceSettings}`;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this.apiKeySettings = ${docLinks.links.security.apiKeyServiceSettings};

If it's preferrable to remove these definitions and use the doc links service directly in the subsequent functions, I can make that change.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, if you can use the links service directly that would be great, thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Actually I think we don't need our own DocumentationLinksService's anymore. But if it's too much for this PR then I'm fine to keep it as is and we'll remove these services in the follow up.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, if we do the cleanup in a subsequent PR that works for me!

@lcawl lcawl added Feature:Security/Authorization Platform Security - Authorization Team:Docs v7.12 v8.0.0 Feature:Security/Spaces Platform Security - Spaces feature release_note:skip Skip the PR/issue when compiling release notes labels Jan 7, 2021
@lcawl lcawl marked this pull request as ready for review January 7, 2021 20:56
@lcawl lcawl requested review from a team as code owners January 7, 2021 20:56
@elasticmachine
Copy link
Contributor

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

@timroes timroes added v7.12.0 and removed v7.12 labels Jan 11, 2021
@azasypkin azasypkin self-requested a review January 11, 2021 12:48
@lcawl
Copy link
Contributor Author

lcawl commented Jan 11, 2021

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
core 564.2KB 564.6KB +401.0B
licenseManagement 23.3KB 23.0KB -233.0B
security 164.7KB 164.9KB +213.0B
spaces 291.5KB 291.5KB -40.0B
total +341.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Member

@azasypkin azasypkin left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Copy link
Contributor

@alisonelizabeth alisonelizabeth left a comment

Choose a reason for hiding this comment

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

Changes to license management LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Security/Authorization Platform Security - Authorization Feature:Security/Spaces Platform Security - Spaces feature release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.12.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants