Make pagefind work in docker #3899

clydebarrow · 2024-06-02T03:34:26Z

Description:

Make live-html work with pagefind;
Make pagefind work in docker

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#

Checklist:

I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
or
I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.
Link added in /index.rst when creating new documents for new components or cookbook.

Make search text clickable; Improve search layout on mobile.

…o pagefind

Make pagefind work in docker

coderabbitai · 2024-06-02T03:35:19Z

Walkthrough

This update introduces several changes aimed at integrating the pagefind tool into the project. The .gitignore file now excludes the _pagefind/ directory. The Dockerfile has been modified to install a specific version of pagefind and set up the environment for the esphome user. The Makefile includes new targets and dependencies for pagefind, and pagefind.yml specifies an output path for generated files.

Changes

File	Change Summary
`.gitignore`	Added `_pagefind/` directory to the ignore list.
`Dockerfile`	Installed `pagefind` version 1.1.0, added architecture-specific adjustments, and setup for `esphome` user.
`Makefile`	Added new `pagefind` target, updated `html`, `live-html`, `html-strict`, and `net-html` targets, and added a `clean` target.
`pagefind.yml`	Added `output_path` setting to specify the output path for generated files.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

netlify · 2024-06-02T03:36:02Z

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	`5c8d2a7`
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/665be9aacd8547000841ac6f
😎 Deploy Preview	https://deploy-preview-3899--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai

Actionable comments posted: 1

coderabbitai · 2024-06-02T03:48:44Z

Dockerfile

+ENV PAGEFIND_VERSION="1.1.0"
+ARG TARGETARCH
+SHELL ["/bin/bash", "-c"]
+RUN <<EOF
+    export TARGETARCH=${TARGETARCH/arm64/aarch64}
+    export TARGETARCH=${TARGETARCH/amd64/x86_64}
+    curl -o pagefind.tar.gz https://github.com/CloudCannon/pagefind/releases/download/v$PAGEFIND_VERSION/pagefind-v$PAGEFIND_VERSION-$TARGETARCH-unknown-linux-musl.tar.gz -L
+    file pagefind.tar.gz
+    ls -l pagefind.tar.gz
+    tar xzf pagefind.tar.gz
+    rm pagefind.tar.gz
+    mv pagefind /usr/bin
+    chmod +x /usr/bin/pagefind
+EOF


Ensure to pin versions for apt packages to avoid unexpected updates. Also, consider simplifying the RUN command for installing pagefind to avoid potential issues with the SHELL directive.

- RUN <<EOF + RUN bash -c "commands..."

Committable suggestion was skipped due low confidence.

Tools

Hadolint

[info] 15-15: Double quote to prevent globbing and word splitting.

clydebarrow added 6 commits May 22, 2024 21:58

Make search results appear in a fixed window;

51eef89

Make search text clickable; Improve search layout on mobile.

On window resize, adjust layout

2032e9b

Maybe make Firefox not resize.

cad3efe

Tweak initial- and maximum-scale

b3375ac

Merge branch 'current' of https://github.com/esphome/esphome-docs int…

957feb6

…o pagefind

Make live-html work with pagefind;

55fdee4

Make pagefind work in docker

probot-esphome bot added the current label Jun 2, 2024

clydebarrow added 2 commits June 2, 2024 13:36

Lint

74f694b

Fix netlify deploy

5c8d2a7

coderabbitai bot reviewed Jun 2, 2024

View reviewed changes

nagyrobi approved these changes Jun 2, 2024

View reviewed changes

nagyrobi merged commit 0fbf7d0 into esphome:current Jun 2, 2024
2 checks passed

github-actions bot locked and limited conversation to collaborators Jun 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make pagefind work in docker #3899

Make pagefind work in docker #3899

clydebarrow commented Jun 2, 2024

coderabbitai bot commented Jun 2, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

netlify bot commented Jun 2, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot Jun 2, 2024

Make pagefind work in docker #3899

Make pagefind work in docker #3899

Conversation

clydebarrow commented Jun 2, 2024

Description:

Checklist:

coderabbitai bot commented Jun 2, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

netlify bot commented Jun 2, 2024 • edited Loading

✅ Deploy Preview for esphome ready!

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Jun 2, 2024

Choose a reason for hiding this comment

coderabbitai bot commented Jun 2, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

netlify bot commented Jun 2, 2024 •

edited

Loading