Skip to content

Update README files using the url placeholder for elastic documentation links#4068

Merged
mrodm merged 9 commits intoelastic:mainfrom
mrodm:add_links_table_file
Sep 9, 2022
Merged

Update README files using the url placeholder for elastic documentation links#4068
mrodm merged 9 commits intoelastic:mainfrom
mrodm:add_links_table_file

Conversation

@mrodm
Copy link
Copy Markdown
Collaborator

@mrodm mrodm commented Aug 25, 2022 •
edited
Loading

What does this PR do?

Update README files to use the new {{ url <key> <link> }} notation introduced in elastic/elastic-package#938

To accomplish that, a new file in the root of the repository links_table.yml has been added with all the links to elastic documentation found in the current packages.

In general, there are no changes in README contents with this PR. There are some changes due to some markdown syntax issues.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • [ ] I have verified that all data streams collect metrics or logs.
  • [ ] I have added an entry to my package's changelog.yml file.
  • [ ] I have verified that Kibana version constraints are current according to guidelines.

How to test this PR locally

  • In elastic-package repository, Build elastic-package command from the branch in the PR (make build)
  • In integrations repository, go to any of the packages updated and run elastic-package build. This command should generate the README without failures.

Author's Checklist

Related issues

@mrodm mrodm added the Team:Ecosystem Packages Ecosystem team [elastic/ecosystem] label Aug 25, 2022
@mrodm mrodm self-assigned this Aug 25, 2022
@mrodm mrodm changed the title Add links table file Update README files using the url placeholder for elastic documentation links Aug 25, 2022
@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Aug 25, 2022 •
edited
Loading

💔 Build Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-09-09T07:57:37.637+0000

  • Duration: 103 min 52 sec

Test stats 🧪

Test Results
Failed 0
Passed 5114
Skipped 9
Total 5123

Steps errors 4

Expand to view the steps failures

Boot up the Elastic stack
  • Took 7 min 26 sec . View more details here
  • Description: ../../build/elastic-package stack up -d -v --version 8.5.0-SNAPSHOT
Boot up the Elastic stack
  • Took 7 min 19 sec . View more details here
  • Description: ../../build/elastic-package stack up -d -v --version 8.5.0-SNAPSHOT
Boot up the Elastic stack
  • Took 7 min 26 sec . View more details here
  • Description: ../../build/elastic-package stack up -d -v --version 8.5.0-SNAPSHOT
Boot up the Elastic stack
  • Took 7 min 4 sec . View more details here
  • Description: ../../build/elastic-package stack up -d -v --version 8.5.0-SNAPSHOT

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Aug 25, 2022 •
edited
Loading

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (290/290) 💚
Files 97.191% (519/534) 👍 0.059
Classes 97.191% (519/534) 👍 0.059
Methods 90.115% (4996/5544) 👍 0.104
Lines 90.948% (94487/103891) 👍 0.063
Conditionals 100.0% (0/0) 💚

@mrodm mrodm force-pushed the add_links_table_file branch from e08d5bb to 3c20e06 Compare August 26, 2022 15:37
@mrodm mrodm mentioned this pull request Sep 6, 2022
Closed
@mrodm mrodm force-pushed the add_links_table_file branch from 3e2a7a6 to 8a5a1dc Compare September 7, 2022 11:52
@mrodm mrodm force-pushed the add_links_table_file branch from f0c51fe to 351682c Compare September 7, 2022 16:00
@mrodm mrodm mentioned this pull request Sep 7, 2022
Closed
2 tasks
mrodm
mrodm commented Sep 7, 2022
View reviewed changes
.ci/Jenkinsfile
Comment on lines +27 to +29
// Elastic package links definitions
ELASTIC_PACKAGE_LINKS_FILE_PATH = "${env.HOME}/${env.BASE_DIR}/links_table.yml"

Copy link
Copy Markdown
Collaborator Author

@mrodm mrodm Sep 7, 2022

Choose a reason for hiding this comment

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

By default, elastic-package would use the file at the root of the directory. But, I would prefer to keep it explicitly this path.

@mrodm mrodm marked this pull request as ready for review September 7, 2022 17:10
@mrodm mrodm requested review from a team as code owners September 7, 2022 17:10
@mrodm mrodm requested review from cmacknz and faec September 7, 2022 17:10
@mrodm mrodm added the enhancement New feature or request label Sep 7, 2022
efd6
efd6 approved these changes Sep 7, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@efd6 efd6 left a comment

Choose a reason for hiding this comment

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

Approving for the SEI-owned files.

Is there testing in elastic-package for use of links that are included in the links_table.yml file to prevent them flowing back in to markdown files?

mtojek
mtojek approved these changes Sep 8, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@mtojek mtojek left a comment

Choose a reason for hiding this comment

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

LGTM

ishleenk17
ishleenk17 approved these changes Sep 8, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@ishleenk17 ishleenk17 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks good! Approving from service integrations

zmoog
zmoog approved these changes Sep 8, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@zmoog zmoog left a comment

Choose a reason for hiding this comment

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

LGTM, from cloud monitoring.

crespocarlos
crespocarlos approved these changes Sep 8, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@crespocarlos crespocarlos left a comment

Choose a reason for hiding this comment

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

LGTM! from Infra Monitoring UI. Tested it following the test steps successfully. elastic-package 0.61 still doesn't support this.

@mrodm
Copy link
Copy Markdown
Collaborator Author

mrodm commented Sep 8, 2022

LGTM! from Infra Monitoring UI. Tested it following the test steps successfully. elastic-package 0.61 still doesn't support this.

Still not released a new version with these changes. This will be included in the next one (0.62.0)

@mrodm
Copy link
Copy Markdown
Collaborator Author

mrodm commented Sep 8, 2022

Approving for the SEI-owned files.

Is there testing in elastic-package for use of links that are included in the links_table.yml file to prevent them flowing back in to markdown files?

For the time being, there is no validation rule in place to check this. Depending on how this evolves, it could be added later a check to enforce the usage of links present in that file.

alvarezmelissa87
alvarezmelissa87 approved these changes Sep 8, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@alvarezmelissa87 alvarezmelissa87 left a comment

Choose a reason for hiding this comment

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

Code LGTM for the ML packages (DGA, Problem child) ⚡

@mrodm mrodm merged commit 70b7404 into elastic:main Sep 9, 2022
@mrodm mrodm deleted the add_links_table_file branch September 9, 2022 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zmoog zmoog zmoog approved these changes

@gizas gizas gizas approved these changes

@crespocarlos crespocarlos crespocarlos approved these changes

@cmacknz cmacknz cmacknz approved these changes

@alvarezmelissa87 alvarezmelissa87 alvarezmelissa87 approved these changes

@efd6 efd6 efd6 approved these changes

@ishleenk17 ishleenk17 ishleenk17 approved these changes

@faec faec Awaiting requested review from faec faec is a code owner automatically assigned from elastic/elastic-agent-data-plane

+1 more reviewer

@mtojek mtojek mtojek approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@mrodm mrodm

Labels

enhancement New feature or request Team:Ecosystem Packages Ecosystem team [elastic/ecosystem]

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update README files using the url placeholder for elastic documentation links

10 participants

@mrodm @elasticmachine @zmoog @gizas @crespocarlos @cmacknz @alvarezmelissa87 @mtojek @efd6 @ishleenk17