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

Add Kustomize #2585

Merged
merged 1 commit into from
Feb 13, 2024
Merged

Conversation

aabouzaid
Copy link
Contributor

@aabouzaid aabouzaid commented Apr 10, 2023

https://github.com/DevOpsHiveHQ/awesome-kustomize

Kustomize introduces a template-free way to customize Kubernetes manifests. It's extensible and uses a purely declarative approach to configuration customization, which will help you efficiently manage your Infrastructure as a code (IaC).

Kustomize is one of the official tools for managing Kubernetes resources, and this list will be the entry point for anyone to learn about Kustomize.

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

Requirements for your pull request

  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List. It should not contain the word Awesome.
    • Add Swift
    • Add Software Architecture
    • Update readme.md
    • Add Awesome Swift
    • Add swift
    • add Swift
    • Adding Swift
    • Added Swift
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
    • - [iOS](…) - Mobile operating system for Apple phones and tablets.
    • - [Framer](…) - Prototyping interactive UI designs.
    • - [iOS](…) - Resources and tools for iOS development.
    • - [Framer](…)
    • - [Framer](…) - prototyping interactive UI designs
  • Your entry should be added at the bottom of the appropriate category.
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
    • Mobile operating system for Apple phones and tablets.
    • Prototyping interactive UI designs.
    • Resources and tools for iOS development.
    • Awesome Framer packages and tools.
  • It's the result of hard work and the best I could possibly produce.
    If you have not put in considerable effort into your list, your pull request will be immediately closed.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
    • awesome-swift
    • awesome-web-typography
    • awesome-Swift
    • AwesomeWebTypography
  • The heading title of your list should be in title case format: # Awesome Name of List.
    • # Awesome Swift
    • # Awesome Web Typography
    • # awesome-swift
    • # AwesomeSwift
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
      • Can be placed centered if the list has a centered graphics header.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Does not use hard-wrapping.
  • Does not include a CI (e.g. GitHub Actions) badge.
    You can still use a CI for linting, but the badge has no value in the readme.
  • Does not include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

@aabouzaid
Copy link
Contributor Author

unicorn

@aabouzaid
Copy link
Contributor Author

This requierment is unclear to me since I'm using a vector format (SVG), and the size doesn't matter.

The image should be high-DPI. Set it to maximum half the width of the original image.

@aabouzaid
Copy link
Contributor Author

@sindresorhus do you have any input on the last point? Do I need to do anything if I use SVG or should I consider it done?

Copy link
Contributor

@benjaoming benjaoming left a comment

Choose a reason for hiding this comment

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

This is a great list.

I would recommend to replace the tables in the "Plugins" section with just flat lists and include them into the general awesome list. These entries should essentially also just be normal "awesome" listings.

@emmanuelgautier emmanuelgautier mentioned this pull request May 2, 2023
32 tasks
@aabouzaid
Copy link
Contributor Author

@benjaoming Thanks for the suggestion 👍
Do you have a suggestion for the format? Because there is some extra info needed for the plugins like the supported model.

@benjaoming
Copy link
Contributor

@aabouzaid Could be like:

  • SopsSecretGenerator - Generating Secrets from sops-encrypted files (methods: Exec, Exec KRM)

(I think it'd be tempting for most awesome list topics to construct their own meta data structures, but I think that consistency and simplicity is preferred... and well that it's an awesome list )

@aabouzaid
Copy link
Contributor Author

@benjaoming that's a good point, thanks for the suggestion 👌
I've changed it to list, actually, it looks better 😀

@aabouzaid
Copy link
Contributor Author

@sindresorhus anything else is needed? All points are covered and there are 3 approvals.

@sindresorhus
Copy link
Owner

#2539 (comment)

This is not a valid review.

You're expected to put a good effort into this and to be thorough.
Comments pointing out lint violation are allowed, but does not count as a review.
https://github.com/sindresorhus/awesome/blob/main/pull_request_template.md

@sindresorhus
Copy link
Owner

The link and description are separated by a dash.

@sindresorhus
Copy link
Owner

https://github.com/aabouzaid/awesome-kustomize#related-lists

Missing descriptions

@aabouzaid
Copy link
Contributor Author

@sindresorhus thanks for your feedback, all points have been addressed.

@aabouzaid
Copy link
Contributor Author

@sindresorhus could we please merge this PR since all notes have been addressed?

@duckodas
Copy link

Seems fine for me

@aabouzaid
Copy link
Contributor Author

aabouzaid commented Nov 5, 2023

I've moved the project to: https://github.com/DevOpsHiveHQ/awesome-kustomize

readme.md Outdated Show resolved Hide resolved
@rojvv rojvv mentioned this pull request Nov 21, 2023
32 tasks
@aabouzaid aabouzaid force-pushed the add-awesome-kustomize branch 2 times, most recently from a5afa5f to f2bcf5c Compare January 13, 2024 10:09
@aabouzaid
Copy link
Contributor Author

For better security, I've signed my commit ✅

@sindresorhus sindresorhus merged commit e02a052 into sindresorhus:main Feb 13, 2024
1 check passed
@sindresorhus
Copy link
Owner

Tweet: https://twitter.com/awesome__re/status/1757518130585522385

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.

8 participants