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

[WIP] All Enhancement proposals in single webpage | KEPs #28295

Closed
wants to merge 12 commits into from

Conversation

shekhar-rajak
Copy link
Contributor

@shekhar-rajak shekhar-rajak commented Jun 5, 2021

This PR is for kubernetes/enhancements#2095 and we want a KEP webpage to find out about specific kep and its metadata easily.

Actual Plan:

  1. [TODO] We will have kep_data.yaml generated in the repo: https://github.com/kubernetes/enhancements - somewhere in data folder - This can be done by CI when new KEP is merged in the repo, it will automatically generate the kep_data.yaml file using the query go run ./cmd/kepctl/main.go query --output yaml > data/kep_data.yaml
  2. kep_data.yaml will be used in this repo website to put in /keps webpage [Currently I have pushed the dump into data folder but in future we want to take it directly from the enhancements repo]
  3. /keps page will display the content in table and we will have search column [TODO] wise like kep-number, sig-group, kep name, etc.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 5, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign tengqm after the PR has been reviewed.
You can assign the PR to them by writing /assign @tengqm in a comment when ready.

The full list of commands accepted by this bot can be found 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 added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 5, 2021
@shekhar-rajak
Copy link
Contributor Author

Currently it is showing the details in /keps page in table with kep-name, kep-number, sig-group name. If anyone want to work on filtering based on columns like kep-number, kep-name,kep-sig and overall search, then feel free to join and commit in the branch.

@netlify
Copy link

netlify bot commented Jun 5, 2021

✔️ Deploy Preview for kubernetes-io-master-staging ready!

🔨 Explore the source changes: 292e29c

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-master-staging/deploys/60be5ddc2974c1000857565e

😎 Browse the preview: https://deploy-preview-28295--kubernetes-io-master-staging.netlify.app

@Rahul-D78
Copy link

Hi @shekhar-rajak I want to work on this can you please provide some resources and what to do in a brief.

@shekhar-rajak
Copy link
Contributor Author

HI @Rahul-D78 ,

  • Get familiar with Hugo and this repo development version - setup it locally and try out how it works
  • Clone this PR branch and check how keeps page is added
  • Try to improve the UI and use already existing way to beautify it
  • Try out how we can add filter column wise/overall search in this new kep page to find out the enhancement proposals/filter, ..

@shekhar-rajak shekhar-rajak changed the title [WIG] All Enhancement proposals in single webpage | KEPs [WIP] All Enhancement proposals in single webpage | KEPs Jun 6, 2021
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 6, 2021
@Rahul-D78
Copy link

Thanks @shekhar-rajak

@shekhar-rajak
Copy link
Contributor Author

Search by keyword, filter by sig-group added. Now need to work on CSS part.

@shekhar-rajak
Copy link
Contributor Author

Bootstrap CSS used to beautify the content: https://deploy-preview-28295--kubernetes-io-master-staging.netlify.app/keps

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Hello @shekhar-rajak

I think KEP list would actually have a better home in https://k8s.dev/ (https://github.com/kubernetes/contributor-site).

Would you like help with adapting this PR to target that other website?

/hold
(I'm open to persuasion about targeting https://kubernetes.io/ rather than https://k8s.dev/ - but I do think that https://k8s.dev/ is the obvious best home).

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 7, 2021
@jberkus
Copy link
Contributor

jberkus commented Jun 7, 2021

Agreed that k8s.dev is the right place, this is information-by-and-for-contributors. How much would have to be redone to move it there?

@kbhawkey
Copy link
Contributor

kbhawkey commented Jun 8, 2021

Hello @shekhar-rajak

I think KEP list would actually have a better home in https://k8s.dev/ (https://github.com/kubernetes/contributor-site).

Would you like help with adapting this PR to target that other website?

/hold
(I'm open to persuasion about targeting https://kubernetes.io/ rather than https://k8s.dev/ - but I do think that https://k8s.dev/ is the obvious best home).

Hi @shekhar-rajak . Yes, I agree with @sftim. Would you open a PR in the kubernetes/contributor-site repository? I think the content belongs in the k8s.dev site. Thanks!

@shekhar-rajak
Copy link
Contributor Author

Thanks @sftim , @berkus, kbhawkey for checking the PR and suggestion. I will work on it .

@shekhar-rajak
Copy link
Contributor Author

Created the PR: kubernetes/contributor-site#222

@berkus
Copy link

berkus commented Jun 12, 2021

@shekhar-rajak hi, you probably meant @jberkus not me.

@shekhar-rajak
Copy link
Contributor Author

Oops , wrong mention. Sorry!

@jberkus
Copy link
Contributor

jberkus commented Jun 21, 2021

Oh, hey @berkus, we meet again!

@berkus
Copy link

berkus commented Jun 26, 2021

@jberkus yep, all the time :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. 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.

7 participants