Docs-website: Kafka monitoring pages did not migrate correctly

Created on 3 Mar 2021  Â·  17Comments  Â·  Source: newrelic/docs-website

(rewritten by Austin)

This doc was in the manual-edits folder, which has caused the migration script to behave a bit weirdly. Two clamshells ("JMX connection errors" and "Kerberos authentication failing") went missing. Compare:

This doc was also in the manual edits folder, and may have issues too

Action items

  1. Compare the docs.newrelic.com and docs-dev.newrelic.com versions of:
  2. Look for any issues or missing content
  3. If you find any, manually fix the docs
P3 bug content from_internal pg_FSO

All 17 comments

@zstix : One element I'd like to add here is a "root cause analysis" of sorts. I just want to make sure we understand why this happened so we can see if other docs might have been effected.

we could rerun the migration script on this or just manually add the missing content. It's probably easier to fix this as content change vs. trying to spend engineering effort on re-running our script. @austin-schaefer - let me know what you think

@jpvajda I'm not too worried about the missing content—it's easy enough to manually restore. As I mentioned in a comment up-thread, I'm more concerned about understanding _why_ this happened and if it could have happened elsewhere. Was this a one-off, or are there other docs that are missing content?

@austin-schaefer we believe it be a one off.

@jpvajda : Can you share more on why we're confident it was a one-off?

@austin-schaefer && @jpvajda . i believe the kafka monitoring integration was in the manual-edits folder so it was likley old content that was never updated before final migration.

@austin-schaefer i'll close this if you are ok correcting manually or you can move it your content board.

Sure, let's move to content board and re-scope to also look at this doc @roadlittledawn shared

src/manual-edits/content/docs/serverless-function-monitoring/aws-lambda-monitoring/enable-lambda-monitoring/enable-serverless-monitoring-aws-lambda-legacy.mdx

The two versions match for https://docs.newrelic.com/docs/serverless-function-monitoring/aws-lambda-monitoring/enable-lambda-monitoring/enable-serverless-monitoring-aws-lambda-legacy/.

However, there are some discrepancies between the two Kafka monitoring versions.

@rhetoric101: Is this the most up-to-date version of this doc? https://docs.newrelic.com/docs/integrations/host-integrations/host-integrations-list/kafka-monitoring-integration/ (There's a different version on https://docs-dev.newrelic.com/docs/integrations/host-integrations/host-integrations-list/kafka-monitoring-integration/)

Hey, this is Roberto from Core Integrations, I was the main contributor to the last big change for the Kafka page. I can confirm the current version is not up to date.

We put quite the effort in this particular page, and clients misconfiguring this integration is a known source of problems for us. It would be awesome if you could keep me posted about any news about this!

I just merged my changes into develop to restore that missing "preparation" section (https://github.com/newrelic/docs-website/pull/1388)

Awesome, thank you very much!

@austin-schaefer It looks like we've addressed the Action Items listed in the issue description. Can we close this issue or should we keep it open?

Let’s close it!


From: Shawn Kilburn @.>
Sent: Thursday, March 25, 2021 2:03:18 PM
To: newrelic/docs-website *
@.>
Cc: Austin Schaefer
@.>; Mention @.*>
Subject: Re: [newrelic/docs-website] Kafka monitoring pages did not migrate correctly (#1123)

@austin-schaeferhttps://github.com/austin-schaefer It looks like we've addressed the Action Items listed in the issue description. Can we close this issue or should we keep it open?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://github.com/newrelic/docs-website/issues/1123#issuecomment-807482378, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ANFFOEYXCNAOO7J5OHIR65DTFOQJNANCNFSM4YRV2GOQ.

Hey Guillermo here from Coreint team too. I just check that the doc has some missing troubleshooting step.
Here is a copy of the Google's cache i took a few weeks ago.
https://docs.google.com/document/d/1A5xyDMe9I8dKKJx6goU_AWp7CKsvr6mvsh6vbcNl26c/edit
Could you add that too? Thanks

@gsanchezgavier, thanks for pointing out that the new troubleshooting information didn't make it through the migration either. Just to confirm, are we just adding back the collapser sections "JMX connection errors" and "Kerberos authentication failing"?

Hi @rhetoric101 , yes that is it thanks

Just to confirm, are we just adding back the collapser sections "JMX connection errors" and "Kerberos authentication failing"?

Was this page helpful?
0 / 5 - 0 ratings