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

Resource page update to include external articles/blogs #1749

Merged
merged 14 commits into from
Jan 23, 2024

Conversation

kingdonb
Copy link
Member

Rebased from:

To address the Flux request for CNCF tech docs team, in cncf/techdocs#192

Thank you @thisisobate!

@kingdonb kingdonb mentioned this pull request Dec 12, 2023
7 tasks
@kingdonb
Copy link
Member Author

@thisisobate Can you explain some of the javascript code changes? I see that you mentioned them in your todo list but I'm not understanding what the search code changes are for. There doesn't seem to be any search on the resources page.

@thisisobate
Copy link
Contributor

So here's a brief summary of how I implemented the filter:

So the filter functions as a search under the hood. The idea is that once a user selects the items to filter, it will now query the index to see if there's a match. If true, it returns the matched record and then renders it on the DOM.

While thinking about this problem, I considered alot of things like internalization and advanced search capabilities. I then decided to use the Lunrjs search package to power the resource filter.

@kingdonb

@kingdonb
Copy link
Member Author

Thanks! I think this looks good, but I can't merge it myself. As soon as someone else is able to review it, I think it's LGTM

@kingdonb
Copy link
Member Author

I would like to rebase and merge this soon. If any objections, please speak up. Targeting merge later on today.

We can use it to promote the Botkube and Flux integration post that @mashby2022 is planning, but I see no issues with merging this as-is (I will rebase it first, preserving the commit authorship as much as possible.)

Thanks again @thisisobate ! And thanks to the CNCF team at large

Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM

Thanks @thisisobate and @kingdonb 🏅

@kingdonb kingdonb force-pushed the resource-page-update branch from 15226ee to 306b4a3 Compare January 23, 2024 22:23
@kingdonb kingdonb merged commit 2d1d3b6 into main Jan 23, 2024
5 checks passed
@kingdonb kingdonb deleted the resource-page-update branch January 23, 2024 22:53
@thisisobate
Copy link
Contributor

Hi @kingdonb @stefanprodan
For some reason, the website is yet to show the latest update.
Please take a look.
Thanks!

@kingdonb
Copy link
Member Author

We looked into it, there is a backport label that needs to be applied, I haven't been merging a lot of PRs to the website since GA so I did not know about it...

You can see the result of the merge on:

https://main.docs.fluxcd.io/

I'll figure out the backporting labels today so that it makes it to FluxCD.io proper - this is a user error problem and it's my problem 😅

@thisisobate
Copy link
Contributor

Oh...thought as much 😅
Thanks for the clarification

@kingdonb kingdonb added the backport:v2-2 To be backported to v2-2 label Jan 24, 2024
@fluxcdbot
Copy link
Member

Successfully created backport PR for v2-2:

@kingdonb
Copy link
Member Author

That worked, it's deployed live and you can see it now:

https://fluxcd.io/resources/

🚀 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:v2-2 To be backported to v2-2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants