-
Notifications
You must be signed in to change notification settings - Fork 98
✨ feat: Migrating from hugo to docusasurus #454
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
base: master
Are you sure you want to change the base?
✨ feat: Migrating from hugo to docusasurus #454
Conversation
- Complete migration of documentation site to Docusaurus - Updated configuration and build setup - Removed unnecessary Hugo files and cleaned up structure - Reorganized static assets and images Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>
Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello @katara-Jayprakash, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request represents a comprehensive architectural shift for the project's website, transitioning from Hugo to Docusaurus. This migration aims to leverage Docusaurus's capabilities for documentation and blog management, streamlining the content generation and presentation process. The changes involve a complete removal of the old Hugo-based site structure, configuration, and content, paving the way for a new Docusaurus-powered experience. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request marks a significant migration of the project's website from Hugo to Docusaurus. The changes involve removing all Hugo-related files and configurations and introducing a new Docusaurus-based structure. My review focuses on the new Docusaurus setup. While the overall structure is sound, I've identified a few critical configuration issues that need to be addressed. These include an incompatible React version in package.json and a missing search plugin configuration in docusaurus.config.js. I've also provided feedback on improving the .gitignore file for better dependency management and some minor suggestions for the navbar and footer to enhance user experience and accessibility. Addressing these points will help ensure a stable and robust launch of the new Docusaurus site.
| # Vscode files | ||
| .vscode | ||
|
|
||
| package-lock.json No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a common best practice to commit package lock files (package-lock.json for npm or yarn.lock for yarn) to source control. This ensures that all developers and CI/CD environments use the exact same dependency versions, leading to reproducible builds. Ignoring package-lock.json can lead to inconsistencies and "works on my machine" issues. Please consider removing this line and committing the appropriate lock file for your project's package manager.
|
/cc @hajnalmt @JesseStutler have a look at it, sir https://volcano-docusaurus.netlify.app/ |
Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>
|
Hi @katara-Jayprakash , I'm also working on migrating the website from hugo to docusasurus locally. Happy to collaborate and sync up so we don’t duplicate work. |
for sure! i can help you in locally setting up the branch,it would be great if you can work on docs sections. |
Sounds good, thanks! I’ll start working on the docs section |
|
Hi @katara-Jayprakash and @labdhiongithub7, I think this is the project proposed for the LFX mentorship. As discussed in the Slack thread by @JesseStutler, we should not start this yet and instead wait for the official selection announcement. Starting now might create an unnecessary burden for the maintainers. |
We’re just experimenting with this PR for now. We don't plan on tagging the maintainers for a formal review or anything yet; we’re just testing things out |
@katara-Jayprakash Do you not think that it is an overkill to blow the CI usage just for experimenting? I personally think that @Tusharjamdade Is right to question the intent of a PR in the repo, The migration has a lot of decisions only mentor/maintainer is supposed to take and then instruct, I too believe it is meaningless to open an Unnecessary PR that blows CI, If I am not wrong volcano too pays for CI checks, not sure if mentors would agree to this unoptimal approach. No offence on intent, we all want to create a good impact, but PR and repo centric work can simply be isolated by creating a fork and giving collaborator access to @labdhiongithub7. Rest is one's personal choice. Apologies for intervention. |
In this issue, i am trying to migrating to docusaurus from hugo version, there are lots of stuff's remaining in this pr, but thought should push it, other can also work on it,
feat: Migrating hugo to docusaurus #455