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

feat(builtin-audit-trails): added built-in section for audit trail #644

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

truszkowski
Copy link
Contributor

@truszkowski truszkowski commented Oct 10, 2024

Description of the change

Added built-in audit trails feature.
Now, we can view audit trail logs in Spacelift.

Checklist

Please make sure that the proposed change checks all the boxes below before requesting a review:

  • I have reviewed the guidelines for contributing to this repository.
  • The preview looks fine.
  • The tests pass.
  • The commit history is clean and meaningful.
  • The pull request is opened against the main branch.
  • The pull request is no longer marked as a draft.
  • You agree to license your contribution under the MIT license to Spacelift (not required for Spacelift employees).
  • You have updated the navigation files correctly:
    • No new pages have been added, or;
    • Only nav.yaml has been updated because the changes only apply to SaaS, or;
    • Only nav.self-hosted.yaml has been updated because the changes only apply to Self-Hosted, or;
    • Both nav.yaml and nav.self-hosted.yaml have been updated.

If the proposed change is ready to be merged, please request a review from @spacelift-io/solutions-engineering. Someone will review and merge the pull request.

Spacelift employees should request reviews from the relevant engineers and are allowed to merge pull requests after they got at least one approval.

Thank you for your contribution! 🙇

Copy link
Contributor

@adamconnelly adamconnelly left a comment

Choose a reason for hiding this comment

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

I wonder if it would make sense to move the audit trail page into the "Main Concepts" section now that it's not just the webhook integration.

@jmfontaine @Daniellem97 what do you think?

@jmfontaine
Copy link
Contributor

I wonder if it would make sense to move the audit trail page into the "Main Concepts" section now that it's not just the webhook integration.

I don't think it suits the Main Concepts section. It is not really a concept and it is not central to understanding Spacelift.

I would keep it where it is since it still is an integration but with added retention.

docs/integrations/audit-trail.md Outdated Show resolved Hide resolved
docs/integrations/audit-trail.md Outdated Show resolved Hide resolved
docs/integrations/audit-trail.md Outdated Show resolved Hide resolved
docs/integrations/audit-trail.md Outdated Show resolved Hide resolved
@adamconnelly
Copy link
Contributor

I wonder if it would make sense to move the audit trail page into the "Main Concepts" section now that it's not just the webhook integration.

I don't think it suits the Main Concepts section. It is not really a concept and it is not central to understanding Spacelift.

I would keep it where it is since it still is an integration but with added retention.

@jmfontaine that's a good point about it not being a concept. The reason I suggested moving it though is that it's no-longer just an integration since we're providing audit functionality built-into the product, along with optionally being able to integrate with an external system. So the default is that you will get auditing without having to configure any integration.

Maybe the "Product" section would make more sense actually? But fair enough if you'd rather not move it - it's in a bit of a grey zone since it's half integration, half not.

@jmfontaine
Copy link
Contributor

@adamconnelly I agree that this is a grey area, but I cannot think of a better location for this information.

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.

4 participants