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

Refactor using docsy. #429

Conversation

xuezhaojun
Copy link
Member

@xuezhaojun xuezhaojun commented Sep 17, 2024

The slides: https://docs.google.com/presentation/d/1iTY-EfcHLXZye9C6af7u9rUyOVDrkAUhdC869SHvJc4/edit#slide=id.g28966f3b7e0_0_61

Where you can view the new look: https://ocm-preview.netlify.app/

Discussion video: https://www.youtube.com/watch?v=kl50rlcHUxU&ab_channel=OpenClusterManagement

PS:

  • the zh part is not included, after review the content, I found only less than 5% part of the whole content is written in zh, that means at this point of time we better focus on providing more easy-to-ready, A class en doc rather multiple languages.
  • The zh blogs and en blogs are merged.
  • The supported by currently not visible since we have new adopters, will refresh this section later.

TODO:

  • The dark mode, versioning, in-site search, and rapid content refresh/reorg... will come after this PR merged.

@xuezhaojun xuezhaojun force-pushed the refactor-using-docsy branch 8 times, most recently from 5f5ff9e to 4c183fc Compare September 17, 2024 13:48
@xuezhaojun
Copy link
Member Author

/assign @mikeshng
/assign @qiujian16

Copy link
Member

@mikeshng mikeshng left a comment

Choose a reason for hiding this comment

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

@xuezhaojun This is amazing! Nice!!

Could you please check and adjust the build GitHub action? It's been building for 4 hrs now.

@dhaiducek
Copy link
Member

@mikeshng Do you have permission to kill it? Looks like it's going to run indefinitely:

Press Ctrl+C to stop

ref: https://github.com/open-cluster-management-io/open-cluster-management-io.github.io/actions/runs/10904427745/job/30260830641?pr=429#step:4:26

@xuezhaojun
Copy link
Member Author

@mikeshng @dhaiducek Thanks for reminding, the github action was updated and passed.

Copy link
Member

@dhaiducek dhaiducek left a comment

Choose a reason for hiding this comment

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

What a massive effort, @xuezhaojun! Thanks for all your work here!

I've left a few minor questions/comments/tweaks.

I'm also wondering: Can the background be set to stay in one place on the home page and all the elements scroll up over top of it? I think that'd be a slick effect if it's feasible.

.github/workflows/postsubmit.yml Outdated Show resolved Hide resolved
.github/workflows/postsubmit.yml Show resolved Hide resolved
OWNERS Show resolved Hide resolved
hugo.yaml Outdated Show resolved Hide resolved
hugo.yaml Outdated Show resolved Hide resolved
content/en/blog/_index.md Outdated Show resolved Hide resolved
Copy link
Member

@mikeshng mikeshng left a comment

Choose a reason for hiding this comment

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

@xuezhaojun this is great. Could you also post this PR and some screenshots in our Slack channel for awareness and potentially some feedback. I just uploaded your presentation to YouTube, maybe you can link that in your Slack post as well. Thanks.

@xuezhaojun xuezhaojun changed the title Refactor using docsy. WIP Refactor using docsy. Sep 18, 2024
Signed-off-by: xuezhaojun <[email protected]>
@xuezhaojun xuezhaojun changed the title WIP Refactor using docsy. Refactor using docsy. Sep 18, 2024
@xuezhaojun
Copy link
Member Author

Hi @dhaiducek @mikeshng thanks for your review and helpful comments, I've updated the PR and posted in our Slack channel: https://kubernetes.slack.com/archives/C01GE7YSUUF/p1726696168876759.

@xuezhaojun
Copy link
Member Author

xuezhaojun commented Sep 18, 2024

What a massive effort, @xuezhaojun! Thanks for all your work here!

I've left a few minor questions/comments/tweaks.

I'm also wondering: Can the background be set to stay in one place on the home page and all the elements scroll up over top of it? I think that'd be a slick effect if it's feasible.

👍 That sounds like a cool feature to add. Currently, I'm purely using the shortcode Docsy recommends in their example, but we can definitely implement the landing page by ourselves.

@mikeshng
Copy link
Member

/approve

Copy link
Contributor

openshift-ci bot commented Sep 19, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mikeshng, xuezhaojun

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

@mikeshng
Copy link
Member

/lgtm

If there are any additional feedback and comments we can fix them in another PR.

@openshift-ci openshift-ci bot added the lgtm label Sep 19, 2024
@openshift-merge-bot openshift-merge-bot bot merged commit 3f36d75 into open-cluster-management-io:main Sep 19, 2024
3 checks passed
@xuezhaojun xuezhaojun deleted the refactor-using-docsy branch September 20, 2024 01:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants