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

Documentation Change #1921

Open
yostos opened this issue Sep 26, 2024 · 0 comments
Open

Documentation Change #1921

yostos opened this issue Sep 26, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation 🆕 New!

Comments

@yostos
Copy link

yostos commented Sep 26, 2024

Affected Page(s)

CI/CD configuration for documentation build process (affects all pages indirectly)

What Could Be Better?

The CI/CD configuration needs to be updated to align with the project's dependency management. Currently, it uses pip, which causes the build to fail for Pull Request #1920 that adds Japanese translations and I18N support.

Other Information

In Pull Request #1920, I've successfully added Japanese translations and implemented I18N support. The documentation builds correctly locally using poe docs-run, confirming that pyproject.toml is properly updated with the necessary dependencies, including the mkdocs-i18n-plugin.

However, the CI/CD build is failing with the error "Config value 'plugins': The "i18n" plugin is not installed". This discrepancy occurs because the CI/CD process is using pip instead of poetry to set up the environment.

To resolve this issue:

  1. Update the CI/CD configuration to use poetry for installing dependencies, ensuring it matches the local development environment.
  2. Alternatively, if switching to poetry in CI/CD is not feasible, explicitly add the installation of mkdocs-i18n-plugin to the pip install commands in the CI/CD script.

This change will allow the successful building of multi-language documentation and enable the merging of PR #1920, enhancing jrnl's accessibility for Japanese-speaking users.

I would appreciate guidance on the preferred approach to update the CI/CD configuration to resolve this discrepancy.

@yostos yostos added 🆕 New! documentation Improvements or additions to documentation labels Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🆕 New!
Projects
None yet
Development

No branches or pull requests

1 participant