-
Notifications
You must be signed in to change notification settings - Fork 167
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
Create NGINX onboarding tutorial #3826
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
Please find my observations, 1. Nginx namingThe Nginx docs page has the naming convention as NGINX. Our integration docs page represents with the naming convention as Nginx. This makes different representation's in the docs page. see below, From Integration page:From the docs page:
2. Alignment
3. Suggestions on Add Agent section
AzureKubernetesNginx |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Just a few thoughts.
NGINX mostly stylizes their name in all caps, but they have trademarked both NGINX and nginx. We should really be using one of those in our integration, but I've now switched instances of NGINX to nginx except when referencing a feature or section of the integration. There I've used Nginx.
Unfortunately, I think this is a bug in our styles due to the horizontal list having more than one line.
Thanks for pointing this out. I think there may be a case for some reuse between these docs. There are some slight differences (mostly in the K8s integration) that may make things a little unclear for users. For now, I would like to keep these instructions here to keep users in the flow, but maintaining all of these separately may become too big of a task so I will look into reuse here and updating the necessary pages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a few editing suggestions, otherwise LGTM.
fa3ffd8
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
(cherry picked from commit 7697da2)
(cherry picked from commit 7697da2)
(cherry picked from commit 7697da2) Co-authored-by: Mike Birnstiehl <[email protected]>
(cherry picked from commit 7697da2) Co-authored-by: Mike Birnstiehl <[email protected]>
This PR closes #3411.
Creates an onboarding tutorial for NGINX using the integration. Includes information on exploring and visualizing data using the built-in dashboard.
Preview available here