Conversation
|
creating on osp/pac cause we need to test cloudfare |
🔍 PR Lint Feedback
|
Summary of ChangesHello, 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 focuses on improving the documentation of the Pipelines-as-Code project by introducing a new theme, enhancing link integrity, and updating the Hugo version. It also adds a new project guide to help developers get started. Highlights
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
|
Deploying pipelines-as-code with
|
| Latest commit: |
fad6432
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f60d79cd.pipelines-as-code.pages.dev |
| Branch Preview URL: | https://new-docs.pipelines-as-code.pages.dev |
There was a problem hiding this comment.
Code Review
This pull request introduces a significant overhaul of the documentation, migrating to the Hextra theme. The changes are extensive, including a new documentation structure, updated content, and the addition of new tooling for quality assurance, such as a link checker. Overall, this is a great improvement to the project's documentation. I have one suggestion regarding the Makefile to ensure a consistent development environment for all contributors.
Note: Security Review did not run due to the size of the PR.
Makefile
Outdated
| dev-docs: | ||
| @hugo server -s docs/ & |
There was a problem hiding this comment.
The dev-docs target has been modified to use the system's hugo command directly, removing the download-hugo dependency. This change requires developers to have hugo installed and available in their PATH, which could lead to inconsistencies if different versions are used. The previous implementation ensured a consistent development environment by downloading a specific version of Hugo. Consider restoring the download-hugo dependency to maintain a self-contained and consistent setup for all contributors.
dev-docs: download-hugo ## preview live your docs with hugo
@$(HUGO_BIN) server -s docs/ &
|
9c76bb5 to
0174404
Compare
|
/lgtm |
There was a problem hiding this comment.
Congrats @chmouel your PR Has been approved 🎉
✅ Pull Request Approved
Approval Status:
- Required Approvals: 1
- Current Approvals: 1
👥 Reviewers Who Approved:
| Reviewer | Permission Level | Approval Status |
|---|---|---|
| @mathur07 | write |
✅ |
📝 Next Steps
- Ensure all required checks pass
- Comply with branch protection rules
- Request a maintainer to merge using the
/mergecommand (or merge it
directly if you have repository permission).
Automated by the PAC Boussole 🧭
Migrate the documentation site from the hugo-book theme to the Hextra theme by imfing. This includes a full replacement of the theme vendor directory, new Hugo configuration (hugo.yaml replacing config.toml), updated layouts and partials (sidebar, footer, mobile TOC, theme toggle), custom CSS with a blue-cyan color scheme, callout styles, and responsive design improvements. Update Hugo version from 0.96.0 to 0.146.0. Reorganize documentation content structure with improved navigation, cards, diagrams, and interactive features. Optimize image assets, add favicon and web manifest, and update the doc generation pipeline (.tekton/doc.yaml, hack/gendocs.sh). Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Add automated link validation using htmltest to detect broken internal and external links in the documentation. Introduce a check-links.sh script that builds the Hugo site, runs htmltest, and validates that all internal markdown references use Hugo's relref shortcode instead of bare relative paths. Add a --fix mode that automatically converts bare relative links to relref shortcodes. Integrate into the CI pipeline (.tekton/linter.yaml), pre-commit hooks, and Makefile targets (check-links, fix-links). Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Replaced the symbolic link with a text file to ensure consistent access to the AGENTS.md documentation. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
📝 Description of the Change
👨🏻 Linked Jira
🔗 Linked GitHub Issue
Fixes #
🧪 Testing Strategy
🤖 AI Assistance
If you have used AI assistance, please provide the following details:
Which LLM was used?
Extent of AI Assistance:
Important
If the majority of the code in this PR was generated by an AI, please add a
Co-authored-bytrailer to your commit message.For example:
Co-authored-by: Gemini gemini@google.com
Co-authored-by: ChatGPT noreply@chatgpt.com
Co-authored-by: Claude noreply@anthropic.com
Co-authored-by: Cursor noreply@cursor.com
Co-authored-by: Copilot Copilot@users.noreply.github.com
**💡You can use the script
./hack/add-llm-coauthor.shto automatically addthese co-author trailers to your commits.
✅ Submitter Checklist
fix:,feat:) matches the "Type of Change" I selected above.make testandmake lintlocally to check for and fix anyissues. For an efficient workflow, I have considered installing
pre-commit and running
pre-commit installtoautomate these checks.