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

📖 (doc) - refactory and clenup the Plugin section #4185

Merged

Conversation

camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Sep 22, 2024

Over time, this section has grown incrementally, leading to content duplication and outdated or irrelevant information. To address this, we are now:

  • Re-organizing the structure for better clarity.
  • Fixing broken or outdated links.
  • Removing duplicated and obsolete content.
  • Re-writing and refining parts of the sections to ensure accuracy and relevance.
  • Ensuring the Kubebuilder layout doc's standards

To review see: https://deploy-preview-4185--kubebuilder.netlify.app/plugins/plugins

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 22, 2024
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 22, 2024
@camilamacedo86 camilamacedo86 force-pushed the cleanup-docs-plugin branch 2 times, most recently from 97b2275 to 41330ca Compare September 22, 2024 10:37
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 22, 2024
@camilamacedo86 camilamacedo86 force-pushed the cleanup-docs-plugin branch 8 times, most recently from e8f6806 to f177303 Compare September 22, 2024 17:35
@camilamacedo86 camilamacedo86 changed the title WIP : cleanup/refactory plugins section 📖 (doc) - refactory and clenup the Plugin section Sep 22, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 22, 2024
@mateusoliveira43
Copy link
Contributor

About broken links, would be interesting to check that through CI? I did not use it, but saw other people using this solution https://github.com/lycheeverse/lychee-action

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 7, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, mateusoliveira43

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:

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

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 7, 2024
Over time, this section has grown incrementally, leading to content duplication and outdated or irrelevant information. To address this, we are now:

- Re-organizing the structure for better clarity.
- Fixing broken or outdated links.
- Removing duplicated and obsolete content.
- Re-writing and refining parts of the sections to ensure accuracy and relevance.
- Ensuring the Kubebuilder layout doc's standards
@camilamacedo86
Copy link
Member Author

@mateusoliveira43

Thank you a lot for your time and amazing review
You helped us so much shape it in a good way.

See that we either organise it as you suggested, which indeed provided a better result

6. plugins
    6.1 available plugins
          6.1.1 go/v4
          6.1.2 grafana/v1-alpha
          6.1.3 deploy-image/v1-alpha
          6.1.4 kustomize/v2

It is much better than before so I think it is good enough to fly.
Anyway, the help from the community and everybody is very welcome to shape it more if needed.

So, for further improvements we can open follow up prs.

@camilamacedo86 camilamacedo86 added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 9, 2024
@k8s-ci-robot k8s-ci-robot merged commit 4f8182c into kubernetes-sigs:master Oct 9, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants