search

F5Networks / f5-telemetry-streaming

F5 BIG-IP Telemetry Streaming
Apache License 2.0
53 stars 24 forks source link

Dcoumentation error - 'Push Consumers' aka setting-up-consumer.rst - AWS_S3 example emphasizes wrong line #277

Open samualblair opened 2 months ago

samualblair commented 2 months ago

Environment

N/A - Documentation bug.

Summary

This is due to error in documentation file: docs/setting-up-consumer.rst

Additions to the AWS S3 consumer section. Calls example file, but configured to highlight the wrong line.

.. literalinclude:: ../examples/declarations/consumers/AWS_S3/aws_s3.json :language: json :emphasize-lines: 12

Steps To Reproduce

Steps to reproduce the behavior:

  1. Submit the following declaration:

Browse to this page of documentation and view section on AWS S3. https://clouddocs.f5.com/products/extensions/f5-telemetry-streaming/latest/setting-up-consumer.html

  1. Observe the wrong line highlighted.

Screenshot 2024-04-05 at 7 50 12 AM

Expected Behavior

The correct line (endpointURL) is highlighted.

Actual Behavior

The wrong line '{' is highlighted.

A Pull request has been created with fix for this: https://github.com/F5Networks/f5-telemetry-streaming/pull/276

samualblair commented 2 months ago

276

pgouband commented 1 month ago

Hi @samualblair,

F5 Contributor License Agreement Before you start contributing to any project sponsored by F5, Inc. (F5) on GitHub, you will need to sign a Contributor License Agreement (CLA).

If you are signing as an individual, we recommend that you talk to your employer (if applicable) before signing the CLA since some employment agreements may have restrictions on your contributions to other projects. Otherwise by submitting a CLA you represent that you are legally entitled to grant the licenses recited therein.

If your employer has rights to intellectual property that you create, such as your contributions, you represent that you have received permission to make contributions on behalf of that employer, that your employer has waived such rights for your contributions, or that your employer has executed a separate CLA with F5.

If you are signing on behalf of a company, you represent that you are legally entitled to grant the license recited therein. You represent further that each employee of the entity that submits contributions is authorized to submit such contributions on behalf of the entity pursuant to the CLA.

samualblair commented 1 month ago

Thanks, @pgouband, do you have any links or instructions for signing an F5 GitHub CLA?

I found some articles for OpenStack, Ansible, and others from various documentation pages. They all seem to be the same 'V1' document with different email groups. I have tried to send to the OpenStack email listed in the documents, but my emails get rejected for not being on an allowed list.

I'm trying Ansible email, so far that one hasn't been rejected yet, so maybe just the OpenStack email group has been shutdown/locked-down.

zednickf5 commented 2 weeks ago

@samualblair please, email tele.stream@f5.com (*** expand to the whole word) to get CLA.

samualblair commented 2 weeks ago

@samualblair please, email tele.stream@f5.com (*** expand to the whole word) to get CLA.

Thanks zednickf5, but I just keep getting undeliverable '503 #5.5.1 RCPT first (in reply to DATA command)' errors. I have tried from two different mail accounts, that don't seem to have problems sending messages otherwise. Are you sure that is a valid destination email?

The repo starts with f5, I also thought maybe f5.tele.stream@f5.com and f5tele.stream@f5.com , but same results with those.

zednickf5 commented 1 week ago

Sorry @samualblair there was an issue with the email address. I've verified it works from external addresses. Please, try telemetry-streaming@...