Skip to content

Conversation

@benironside
Copy link
Contributor

This PR adds 8.10 branches to the conf.yaml file.

@benironside benironside added the release Apply to issues tracking docs for releases label Aug 21, 2023
@benironside benironside requested a review from lcawl August 21, 2023 17:38
@benironside benironside self-assigned this Aug 21, 2023
@jrodewig
Copy link
Contributor

Hey @benironside! Can you update or rebase this branch to include changes from #2742?

We'll want to add the 8.10 branch for that new book as well.

@lcawl
Copy link
Contributor

lcawl commented Aug 21, 2023

The current build error:

10:51:12 INFO:build_docs:Error executing: git archive --format=tar -o /tmp/docsbuild/aFUKK6lgkb/elasticsearch-php/.temp_git_archive.tar 8.10 docs/examples in GIT_DIR /docs_build/.repos/elasticsearch-php.git

... indicates that this repo doesn't have an 8.10 branch yet: https://github.com/elastic/elasticsearch-php

To solve that error, we can update the conf.yaml to temporarily remove that branch for the PHP client book, and/or ask the clients team how soon they'll create the missing branch

@benironside
Copy link
Contributor Author

Thanks @jrodewig , I added the content from #2742 and added the 8.10 branch reference to the new item.
Thanks @lcawl , I reached out to the clients team about the missing branch.

Appreciate your help!

@benironside
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs rebuild

@jrodewig
Copy link
Contributor

jrodewig commented Aug 22, 2023

Hey @benironside — I pushed 3978c60 (#2743) to remove the 8.10 branch for the ES PHP client. That'll unblock this PR. I'll work with Client Languages to get that branch added once they create it.

@benironside
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs rebuild

@lcawl
Copy link
Contributor

lcawl commented Aug 22, 2023

The current build errors are ones I can recreate locally by checking out 8.10 and building the security guide:

04:40:57 INFO:build_docs:
04:40:57 INFO:build_docs:asciidoctor: ERROR: detections/prebuilt-rules/downloadable-packages/8-10-1/prebuilt-rules-8-10-1-appendix.asciidoc: line 46: include file not found: /tmp/docsbuild/8ytzuFdx36/security-docs/docs/detections/prebuilt-rules/downloadable-packages/8-10-1/prebuilt-rule-8-10-1-suspicious-network-connection-attempt-by-root.asciidoc
04:40:57 INFO:build_docs:asciidoctor: WARNING: invalid reference: enumerating-domain-trusts-via-nltest.exe

Per discussion with @benironside these seem to be caused by problems in https://github.com/elastic/security-docs/blob/8.10/docs/detections/prebuilt-rules/[…]oadable-packages/8-10-1/prebuilt-rules-8-10-1-appendix.asciidoc (tries to include non-existent file) and https://github.com/elastic/security-docs/blob/8.10/docs/detections/prebuilt-rules/rule-details/enumerating-domain-trusts-via-nltest-exe.asciidoc (is a target of links but isn't published since it doesn't seem to be in any nav files).

@terrancedejesus
Copy link

@benironside - As we discussed, the issue is caused by incorrect file names and links to non-existent docs which derive from a security docs generation bug in our existing workflow. Apologies for this.

Here is a bug issue for our repo to have this fixed on our end to avoid this issue in the future: elastic/detection-rules#3032

@jrodewig
Copy link
Contributor

It looks like the Lang Clients team have created the 8.10 branches. I'm going to re-add those in the meantime.

@lcawl
Copy link
Contributor

lcawl commented Aug 24, 2023

@elasticmachine run elasticsearch-ci/docs

@lcawl
Copy link
Contributor

lcawl commented Aug 24, 2023

@elasticmachine run elasticsearch-ci/docs rebuild

@lcawl
Copy link
Contributor

lcawl commented Aug 25, 2023

@elasticmachine run elasticsearch-ci/docs

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM

@lcawl lcawl merged commit b076e42 into master Aug 25, 2023
@lcawl lcawl deleted the big-8.10-conf.yaml branch August 25, 2023 01:37
@jrodewig
Copy link
Contributor

Thanks so much for getting this over the finish line @lcawl. 🏁

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

Labels

release Apply to issues tracking docs for releases

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants