Skip to content

Conversation

@bmorelli25
Copy link
Member

@bmorelli25 bmorelli25 commented Sep 13, 2019

  • Allows APM Server to take advantage of the new shared version file by adding apm_server_version
  • Allows us to finally stop linking to current versions of all APM Agent documentation 🎉
    • Moves APM Agent version attributes to the shared version files.
    • Moves APM Agent attributes from the APM Server version file to the shared attributes file

@bmorelli25
Copy link
Member Author

I'm going to try deprecating the -v links instead. If this ci build is too ugly I might go back to the original option... we'll see 🤞

@bmorelli25
Copy link
Member Author

Well that's cool. Updating the ref links from current to versioned didn't break anything! Can I get an Amen! LGTM?

Copy link
Member

@nik9000 nik9000 left a comment

Choose a reason for hiding this comment

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

LGTM but for a little extra paranoia lets rebuild everything and make sure nothin weird happened.

@elasticmachine, run elasticsearch-docs/doc rebuild

@nik9000
Copy link
Member

nik9000 commented Sep 16, 2019

@elasticmachine, run elasticsearch-docs/doc rebuild

@nik9000
Copy link
Member

nik9000 commented Sep 16, 2019

@elasticmachine, run elasticsearch-ci/docs rebuild

@nik9000
Copy link
Member

nik9000 commented Sep 16, 2019

I noticed these in the last run, actually:

06:00:42 INFO:build_docs:Bad cross-document links:
06:00:42 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/elastic-stack/7.3/apm-highlights.html:
06:00:42 INFO:build_docs:   - en/apm/agent/dotnet/{apm-dotnet-branch}/public-api.html
06:00:42 INFO:build_docs:   - en/apm/agent/rum-js/{apm-rum-branch}/react-integration.html
06:00:42 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/elastic-stack/current/apm-highlights.html:
06:00:42 INFO:build_docs:   - en/apm/agent/dotnet/{apm-dotnet-branch}/public-api.html
06:00:42 INFO:build_docs:   - en/apm/agent/rum-js/{apm-rum-branch}/react-integration.html

@bmorelli25
Copy link
Member Author

@nik9000 SMART. Thank you for doing that. I'll look into those links.

@bmorelli25
Copy link
Member Author

bmorelli25 commented Sep 17, 2019

So this is really interesting. These broken links are in the stack docs, but they're only there because they're included via a tagged region. The links really live in the APM Overview. Specifically, this page, where they work 🤔. For some reason, the attributes for :apm-dotnet-branch: and :apm-rum-branch: aren't making it to the stack docs.

@bmorelli25
Copy link
Member Author

bmorelli25 commented Sep 17, 2019

Ahhh, this could be because the stack-docs only just started using the shared version file at 4:29pm GMT yesterday (elastic/stack-docs#512) and @nik9000 started the rebuild test on this PR at 3:55pm GMT yesterday. I think if I rebuild again this should be fixed.

@elasticmachine, run elasticsearch-ci/docs rebuild

@bmorelli25
Copy link
Member Author

@elasticmachine, run elasticsearch-ci/docs rebuild

@bmorelli25
Copy link
Member Author

bmorelli25 commented Sep 17, 2019

Alright, I'm officially stuck. This PR build keeps failing on the ESS docs, which should be unrelated:

ERROR building Elasticsearch Service - Hosted Elasticsearch and Kibana branch release-ms-25

I ran a rebuild in elastic/docs and it passed with flying colors: https://elasticsearch-ci.elastic.co/job/elastic+docs+master+build/4946/console

@bmorelli25 bmorelli25 force-pushed the add-apm-server-to-shared branch from 888b47e to ba98b4c Compare September 17, 2019 11:30
@nik9000
Copy link
Member

nik9000 commented Sep 17, 2019 via email

@bmorelli25
Copy link
Member Author

🤦‍♂ Yeah, that worked. Going to do one more rebuild just to be safe, but the recent ci/docs was just green.

@elasticmachine, run elasticsearch-ci/docs rebuild

@bmorelli25
Copy link
Member Author

Actually, it didn't work. Same ESS failure: https://elasticsearch-ci.elastic.co/job/elastic+docs+docs+pull-request/271/console

@bmorelli25
Copy link
Member Author

@elasticmachine, run elasticsearch-ci/docs rebuild

@bmorelli25
Copy link
Member Author

bmorelli25 commented Sep 17, 2019

Nik's fix worked! Now the problem is about 300 broken links due to unresolved attributes.

I believe this is happening because APM Server isn't yet using the shared version file (where the attributes are described). I think I need to merge and backport elastic/apm-server#2712 simultaneously with this PR. I should be able to merge elastic/apm-server#2712 and backport it without any problems. Then I can merge this PR.

@bmorelli25
Copy link
Member Author

I'm not going to remove the -v branches in this PR. There are waaaaaay to many moving pieces and this has been a nightmare tracking down broken links.

I'm taking this PR back to its roots by simply adding APM Server and APM Agents to the shared versioning files.

@bmorelli25
Copy link
Member Author

@elasticmachine, run elasticsearch-ci/docs rebuild

@bmorelli25 bmorelli25 force-pushed the add-apm-server-to-shared branch from 4466ae9 to 26eb41c Compare September 20, 2019 08:21
@bmorelli25
Copy link
Member Author

@elasticmachine, run elasticsearch-ci/docs rebuild

@bmorelli25
Copy link
Member Author

After many, many attempts at this, the docs/ci rebuild is finally green.

@bmorelli25 bmorelli25 merged commit b0c20c9 into elastic:master Sep 20, 2019
@bmorelli25 bmorelli25 deleted the add-apm-server-to-shared branch September 20, 2019 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants