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

📝 docs: Sync updates to English docs #3555

Merged
merged 1 commit into from
Aug 22, 2024
Merged

📝 docs: Sync updates to English docs #3555

merged 1 commit into from
Aug 22, 2024

Conversation

arvinxx
Copy link
Contributor

@arvinxx arvinxx commented Aug 22, 2024

Synchronize updates from Chinese documentation to English versions for server database deployment and authentication configuration.

  • docs/self-hosting/server-database/docker.mdx

    • Add instructions for creating a Postgres database instance with the PGVector plugin.
    • Update environment variables in lobe-chat.env to include APP_URL and additional details for NEXT_AUTH_SSO_PROVIDERS.
    • Modify Docker run command to include APP_URL and other updated environment variables.
  • docs/self-hosting/server-database.mdx

    • Add a note about the need for the pgvector plugin for Postgres.
    • Include a callout about modifying NEXT_PUBLIC prefixed environment variables in Docker deployment.
    • Remove detailed S3 configuration steps and refer to the S3 Object Storage documentation for more information.
  • docs/self-hosting/advanced/auth.mdx

    • Update the title and description to reflect the configuration of external authentication services.
    • Add backticks around environment variables for better readability.
    • Remove redundant information and streamline the content for clarity.

For more details, open the Copilot Workspace session.

Synchronize updates from Chinese documentation to English versions for server database deployment and authentication configuration.

* **docs/self-hosting/server-database/docker.mdx**
  - Add instructions for creating a Postgres database instance with the PGVector plugin.
  - Update environment variables in `lobe-chat.env` to include `APP_URL` and additional details for `NEXT_AUTH_SSO_PROVIDERS`.
  - Modify Docker run command to include `APP_URL` and other updated environment variables.

* **docs/self-hosting/server-database.mdx**
  - Add a note about the need for the `pgvector` plugin for Postgres.
  - Include a callout about modifying `NEXT_PUBLIC` prefixed environment variables in Docker deployment.
  - Remove detailed S3 configuration steps and refer to the S3 Object Storage documentation for more information.

* **docs/self-hosting/advanced/auth.mdx**
  - Update the title and description to reflect the configuration of external authentication services.
  - Add backticks around environment variables for better readability.
  - Remove redundant information and streamline the content for clarity.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/lobehub/lobe-chat?shareId=XXXX-XXXX-XXXX-XXXX).
Copy link

vercel bot commented Aug 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
lobe-chat-database ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 22, 2024 11:44am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
lobe-chat-preview ⬜️ Ignored (Inspect) Visit Preview Aug 22, 2024 11:44am

@lobehubbot
Copy link
Member

👍 @arvinxx

Thank you for raising your pull request and contributing to our Community
Please make sure you have followed our contributing guidelines. We will review it as soon as possible.
If you encounter any problems, please feel free to connect with us.
非常感谢您提出拉取请求并为我们的社区做出贡献,请确保您已经遵循了我们的贡献指南,我们会尽快审查它。
如果您遇到任何问题,请随时与我们联系。

@arvinxx arvinxx changed the title Sync updates to English docs 📝 docs: Sync updates to English docs Aug 22, 2024
@arvinxx arvinxx merged commit 58d8f57 into main Aug 22, 2024
9 of 10 checks passed
@arvinxx arvinxx deleted the arvinxx/sync-docs branch August 22, 2024 11:39
@lobehubbot
Copy link
Member

❤️ Great PR @arvinxx ❤️

The growth of project is inseparable from user feedback and contribution, thanks for your contribution! If you are interesting with the lobehub developer community, please join our discord and then dm @arvinxx or @canisminor1990. They will invite you to our private developer channel. We are talking about the lobe-chat development or sharing ai newsletter around the world.
项目的成长离不开用户反馈和贡献,感谢您的贡献! 如果您对 LobeHub 开发者社区感兴趣,请加入我们的 discord,然后私信 @arvinxx@canisminor1990。他们会邀请您加入我们的私密开发者频道。我们将会讨论关于 Lobe Chat 的开发,分享和讨论全球范围内的 AI 消息。

Copy link

codecov bot commented Aug 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.66%. Comparing base (aa936c8) to head (158f5cd).
Report is 1340 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3555   +/-   ##
=======================================
  Coverage   91.66%   91.66%           
=======================================
  Files         448      448           
  Lines       29408    29408           
  Branches     2084     2088    +4     
=======================================
  Hits        26956    26956           
  Misses       2452     2452           
Flag Coverage Δ
app 91.66% <ø> (ø)
server 96.79% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lobehubbot
Copy link
Member

🎉 This PR is included in version 1.12.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

akvsdk pushed a commit to akvsdk/lobe-chat that referenced this pull request Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants