Skip to content
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

Reorganise AWS docs and Apps tab #49

Merged
merged 38 commits into from
Sep 12, 2024

Conversation

dasfmi
Copy link
Contributor

@dasfmi dasfmi commented Aug 27, 2024

This PR rewrites and reorganises the AWS docs and the Apps tab:

  • Create a central place for all data collection from AWS services (Send Data > AWS).
  • Clearly separate Send Data and Apps sections.
  • Update information about collecting data from different AWS services based on GitHub readmes.
  • Restructure many existing pages to better fit current style.
  • Move PagerDuty to Monitors section.
  • Add new pages:
    • Overview page for AWS services
    • Send data from Firehose
    • Use AWS Lambda app to enrich your Axiom organization

This PR is a prerequisite for changing the GitHub readmes:

@dasfmi dasfmi force-pushed the islam/axm-4903-create-top-level-aws-page branch from 61edbe1 to c19135f Compare August 27, 2024 16:41
@tothmano tothmano self-assigned this Aug 29, 2024
@tothmano tothmano self-requested a review August 29, 2024 13:50
@tothmano tothmano assigned dasfmi and unassigned tothmano Aug 29, 2024
@tothmano tothmano changed the title [WIP] created AWS overview page Reorganise AWS Sep 9, 2024
send-data/aws-overview.mdx Outdated Show resolved Hide resolved
send-data/aws-overview.mdx Outdated Show resolved Hide resolved
send-data/aws-overview.mdx Outdated Show resolved Hide resolved
@tothmano
Copy link
Collaborator

tothmano commented Sep 9, 2024

@schehata Thanks a lot for this. I've restructured and rewritten it to align it better with the rest of the docs.

One thing I've noticed is that the table you'd created references a docs page on Firehose which we don't have yet. Do we even support this?

@tothmano tothmano changed the title Reorganise AWS Reorganise AWS docs, add overview page Sep 9, 2024
@tothmano tothmano marked this pull request as ready for review September 12, 2024 09:17
@tothmano tothmano assigned tothmano and unassigned dasfmi Sep 12, 2024
@tothmano tothmano changed the title Reorganise AWS docs, add overview page Reorganise AWS docs and Apps tab Sep 12, 2024
@tothmano tothmano requested review from tothmano and removed request for tothmano September 12, 2024 09:49
@dominicchapman
Copy link
Member

@tothmano this is really taking shape. Great job.

Some comments:

  • Amazon CloudWatch, not AWS CloudWatch. This is widespread in material, so let’s please update all references.
  • We intentionally named the CloudWatch Forwarder as Axiom CloudWatch Forwarder to make it clear that we were responsible for creating this tooling. When I read these docs, it would be easy for me to think that Amazon were responsible for the CloudWatch Forwarder, which they are not. I expect the name change will be sufficient to clear that up.
  • We should simultaneously make PRs to clean up the descriptions from AWS related GitHub repos like https://github.com/axiomhq/axiom-cloudwatch-forwarder with a pointer back to our docs instead.
  • Knowing that the Axiom CloudWatch Forwarder (and other collection methods where this is true) is open source is important. We should include some kind of note on the associated docs page that source code is open source, available at [link] and welcome improvements via contributions.
  • Let’s invite people to submit requests for support for other AWS services with a callout block or similar. It could encourage readers to contact us at [email protected] with requests for new AWS services.

Fantastic AWS Lambda Apps page. This is exactly what I was hoping for. In a future iteration, it would be delightful to include a screenshot or similar to bring that experience to life. No need to stall this work on that, though.

Hope this helps!

Copy link
Member

@dominicchapman dominicchapman left a comment

Choose a reason for hiding this comment

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

Great job!

@tothmano tothmano merged commit e14451d into main Sep 12, 2024
1 check passed
@tothmano tothmano deleted the islam/axm-4903-create-top-level-aws-page branch September 12, 2024 13:03
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