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.

Sign up for GitHub

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

Jump to bottom

docs(README.md): add scope/status badge and simply doc structure #2611

Merged
merged 1 commit into from Jun 6, 2023
Merged

docs(README.md): add scope/status badge and simply doc structure #2611

merged 1 commit into from Jun 6, 2023

Conversation

leogr
Copy link
Member

@leogr leogr commented Jun 5, 2023

What type of PR is this?

/kind cleanup

/kind design

Any specific area of the project related to this PR?

What this PR does / why we need it:

See falcosecurity/evolution#273

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@leogr
docs(README.md): add scope/status badge and simply doc structure
925acf2 
Signed-off-by: Leonardo Grasso <me@leonardograsso.com>
@poiana poiana requested review from FedeDP and Kaizhe June 5, 2023 16:32
incertum
incertum approved these changes Jun 5, 2023
View reviewed changes
Copy link
Contributor

@incertum incertum left a comment

Choose a reason for hiding this comment

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

Thank you @leogr, this is great, LGTM!

@poiana poiana added the lgtm label Jun 5, 2023
@leogr
Copy link
Member Author

leogr commented Jun 5, 2023

/milestone 0.35.0

(anyway, since this is just documentation, it can be postponed if needed)

@poiana poiana added this to the 0.35.0 milestone Jun 5, 2023
jasondellaluce
jasondellaluce approved these changes Jun 6, 2023
View reviewed changes
Copy link
Contributor

@jasondellaluce jasondellaluce left a comment

Choose a reason for hiding this comment

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

/approve

❤️

FedeDP
FedeDP reviewed Jun 6, 2023
View reviewed changes
README.md

[![Build Status](https://img.shields.io/circleci/build/github/falcosecurity/falco/master?style=for-the-badge)](https://circleci.com/gh/falcosecurity/falco) [![CII Best Practices Summary](https://img.shields.io/cii/summary/2317?label=CCI%20Best%20Practices&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/2317) [![GitHub](https://img.shields.io/github/license/falcosecurity/falco?style=for-the-badge)](COPYING) [![Latest](https://img.shields.io/github/v/release/falcosecurity/falco?style=for-the-badge)](https://github.com/falcosecurity/falco/releases/latest) ![Architectures](https://img.shields.io/badge/ARCHS-x86__64%7Caarch64-blueviolet?style=for-the-badge)
[![Falco Core Repository](https://github.com/falcosecurity/evolution/blob/main/repos/badges/falco-core-blue.svg)](https://github.com/falcosecurity/evolution/blob/main/REPOSITORIES.md#core-scope) [![Stable](https://img.shields.io/badge/status-stable-brightgreen?style=for-the-badge)](https://github.com/falcosecurity/evolution/blob/main/REPOSITORIES.md#stable) [![OpenSSF Best Practices](https://img.shields.io/cii/summary/2317?label=OpenSSF%20Best%20Practices&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/2317)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd also add a CI badge from github actions (instead of circleci):

[![Dev Packages and Docker images](https://github.com/falcosecurity/falco/actions/workflows/master.yaml/badge.svg?branch=master)](https://github.com/falcosecurity/falco/actions/workflows/master.yaml)

Copy link
Member Author

Choose a reason for hiding this comment

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

@FedeDP

Since we don't have clear documentation on downloading and then using dev builds, I'd wait to add the badge until we have addressed this issue.

So, I'm just proposing to postpone your request to another PR. Would it work for you?

Copy link
Contributor

Choose a reason for hiding this comment

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

I mean, i was suggesting a badge to quickly check CI status (ie: if master is broken); it is useful for devs and users IMHO.
I am ok with dropping the packages table.

FedeDP
FedeDP approved these changes Jun 6, 2023
View reviewed changes
Copy link
Contributor

@FedeDP FedeDP left a comment

Choose a reason for hiding this comment

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

/approve

@poiana poiana merged commit 004acff into master Jun 6, 2023
16 checks passed
@poiana
Copy link

poiana commented Jun 6, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: FedeDP, incertum, jasondellaluce, leogr

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [FedeDP,jasondellaluce,leogr]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@poiana poiana deleted the docs/readme-badges-and-refinements branch June 6, 2023 08:42
@FedeDP
Copy link
Contributor

FedeDP commented Jun 6, 2023

I'd move this to 0.36 because it makes no sense to cherry pick it for release branch.
/milestone 0.36.0

@poiana poiana modified the milestones: 0.35.0, 0.36.0 Jun 6, 2023
@FedeDP
Copy link
Contributor

FedeDP commented Jun 6, 2023

/milestone 0.35.0

Even if it is just a documentation, it is part of the release. I think it is better to cherry pick on the release branch to avoid confusion (wrong package table on the release readme).

@poiana poiana modified the milestones: 0.36.0, 0.35.0 Jun 6, 2023
@FedeDP FedeDP mentioned this pull request Jun 6, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FedeDP FedeDP FedeDP approved these changes

@jasondellaluce jasondellaluce jasondellaluce approved these changes

@incertum incertum incertum approved these changes

@Kaizhe Kaizhe Awaiting requested review from Kaizhe

Assignees

@FedeDP FedeDP

@jasondellaluce jasondellaluce

@incertum incertum

Labels
approved dco-signoff: yes kind/cleanup lgtm release-note-none size/M
Projects
Falco Roadmap
Archived in project
Milestone
0.35.0
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@leogr @poiana @FedeDP @jasondellaluce @incertum