-
Notifications
You must be signed in to change notification settings - Fork 2
Initiate landing site build #3
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: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Laura Santamaria <[email protected]>
Signed-off-by: Laura Santamaria <[email protected]>
Signed-off-by: Laura Santamaria <[email protected]>
Signed-off-by: Laura Santamaria <[email protected]>
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.
Summary of Changes
Hello @nimbinatus, 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 initiates the development of a new static landing page for the bootc
project. I've chosen Zola, a Rust-based static site generator, along with the Juice theme, to create a modern and maintainable web presence. The changes include setting up the site's core structure, content, and configuration, as well as providing clear instructions for local development and build processes.
Highlights
- Static Site Initialization: I've set up the foundational structure for the
bootc
landing page using Zola, a Rust-based static site generator, and integrated the Juice theme. - Core Content & Structure: I've established the main content pages including the homepage (
_index.md
), an 'About' section with sub-pages (About, Adopters, Changelog, Contributing, Governance, Maintainers, Security), and a 'News' section with an example post. - Zola Configuration: I've configured the Zola site's
config.toml
to define the base URL, title, description, enable features like Sass compilation, search indexing, RSS feeds, sitemap, and robots.txt generation, and set up markdown rendering options. - Custom Templating: I've introduced custom Zola templates (
_macros.html
,_variables.html
,imported.html
,index.html
,news-page.html
) to extend the Juice theme, customize the hero section, define site-wide styles, and enable dynamic content loading from external Markdown files (e.g., for Adopters, Contributing). - Build Instructions: I've updated the root
README.md
with comprehensive instructions on how to build and serve the new Zola-based site locally, including details on the site's directory structure. - Git Submodule for Theme: I've added the
juice
theme as a Git submodule undersite/themes/juice
, ensuring the theme is properly versioned and included. - Git Ignore Updates: I've added
site/public/
(Zola build output) and.idea
(IDE files) to the.gitignore
to keep the repository clean.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
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 .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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 is a great start for the new landing site. It sets up the Zola project with a theme, basic configuration, and initial content. I've identified a few areas for improvement, including a critical bug in the Table of Contents generation, a broken link on the homepage, and several medium-severity issues related to maintainability and content correctness. Addressing these points will help create a more robust and polished website.
Signed-off-by: Laura Santamaria <[email protected]>
Signed-off-by: Laura Santamaria <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
site/config.toml
Outdated
@@ -0,0 +1,62 @@ | |||
base_url = "https://bootc-dev.github.io" |
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.
For a net-new site, perhaps looking to use the bootc.dev domain would be easier for people to remember? I think Jorge has already transferred ownership to CNCF.
Then eventually migrate the other site to docs.bootc.dev?
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.
Ooo, yes, it would be much better.
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.
Updated the domain. Leaving this unresolved as we need to point everything to the github pages underneath, and because the docs need to migrate.
…bootc.dev for use Signed-off-by: Laura Santamaria <[email protected]>
Aren't we missing something like a github workflow to build and publish this? |
And I think if there was a workflow here it'd also potentially publish a preview version of the site on PRs which would be nice. |
@cgwalters yes, the github workflow isn't in the PR. As this is a github.io repo, part of the build system is done in the settings, and then part is an Action. I don't have a local way to test actions, so I wanted to get the code checked first in case adding the action caused me to accidentally take down the documentation site (since it's running on the same github.io url). At the moment, if this is merged, all it does is just add the code to the repo. Then we can work on the publication part. I'm happy to do it all in one go, though, if you'd rather. |
This PR starts a static site as a landing page for bootc. It uses Zola, a Rust-based static site generator, and the Juice template. I chose Zola as the project is primarily Rust, so I thought this would be the most familiar to the largest number of contributors :)