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

Rename contrib repository to evolution #14

Closed
krisnova opened this issue May 6, 2020 · 8 comments · Fixed by #24
Closed

Rename contrib repository to evolution #14

krisnova opened this issue May 6, 2020 · 8 comments · Fixed by #24
Labels
kind/feature New feature or request

Comments

@krisnova
Copy link
Contributor

krisnova commented May 6, 2020

Motivation

Following falcosecurity/falco#1184 I would like for this repository to be a repository that holds the following.

  • Documentation on the evolution process (what is contrib, repo, and official? How do they work? How do you progress?)
  • A /contrib directory which serves as the storage for what is now this repository
  • A /official directory with documentation about our current official support
  • A /repo directory (maybe with YAML like Kubernetes uses for slack channels) that defines our repositories and OWNERS
  • Links to artifacts

Feature

Can we rename this repository and structure it in such a way that we can automate some of this in the future?

Alternatives

Additional context

@krisnova krisnova added the kind/feature New feature or request label May 6, 2020
@leodido
Copy link
Member

leodido commented May 6, 2020

I'd call it "yamloution" 😃

Anyway, I agree on this proposal.

The only thing I'd add is: it woud be rad if the OWNERS listed into the /repo YAMLs would be automatically collected from the OWNERS file we already have in place.
Don't you think? :)

@maxgio92
Copy link
Member

maxgio92 commented May 7, 2020

So the /official directory in this repo will contain documentation of the projects that probably passed through the repository step (as for this), and which sources probably have a dedicated repository, am I right?

@leogr
Copy link
Member

leogr commented May 7, 2020

@maxgio92 yep, I think so

@leodido I strongly agree because you said "automatically" 💘 😝

@kris-nova I agree too, but why /official could not be implemented as like as /repo? I'd like the idea of having official documentation in their own repos with /official that just indexes them.

@nibalizer
Copy link
Contributor

nibalizer commented May 7, 2020

Overall I agree. For /repo I have done this on a few different projects so 100% agree we need the big yaml file(s) that have metadata about the repos. I would like to see that in the same repo as our prow configs since it's a lot of the same data and having them in the same repo makes it possible to set up checks and avoid simple 'added it in one place, didn't add it in the other place' errors. I don't care which repo that is but having them close to each other makes sense I think.

@krisnova krisnova reopened this May 13, 2020
@fntlnz
Copy link
Contributor

fntlnz commented May 15, 2020

I like the new name and the reasoning behind it - 👍

@maxgio92
Copy link
Member

I agree with @nibalizer to keep the /repo data centralized, I don't know if the test-infra could be the right one.

@leodido
Copy link
Member

leodido commented May 21, 2020

I've changed my mind on the subdirectories repo/ and official/ by observing the eventual final result in the PR.

It seems overkill to create subdirectories here with other files/YAMLs/etc.
They could cause other maintenance burden, duplication, and confusion.

I would simply keep "sandbox" things in this repository (whatever its name is).

  • Everything here is "sandbox".
  • Everything with its own repo (with its own OWNERS) is "incubated".
  • Every artifact provided by the main Falco repo (and document so on the website) is "official".

Furthermore, we already have an auditable list of all the repositories and things in this organization. You can find it into test-infra/prow YAML files.

This way identifying the single source of truth is easier for everyone approaching the Falco projects, IMHO.

It sounds more KISS approach in this way to me.

@leogr
Copy link
Member

leogr commented May 25, 2020

Hey @leodido

IMHO we can proceed with renaming this repo then merge the PR #24

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants