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.

Sign up for GitHub

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

Jump to bottom

docs: add description of the docker environment variable #137

Merged
merged 5 commits into from
Dec 16, 2022
Merged

docs: add description of the docker environment variable #137

merged 5 commits into from
Dec 16, 2022

Conversation

ruibaby
Copy link
Member

@ruibaby ruibaby commented Dec 9, 2022

为部署文档提供 Docker 环境变量的解释。

/kind documentation

None

@f2c-ci-robot f2c-ci-robot bot added kind/documentation Categorizes issue or PR as related to documentation. release-note-none Denotes a PR that doesn't merit a release note. labels Dec 9, 2022
@vercel
Copy link

vercel bot commented Dec 9, 2022 •
edited
Loading

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

Name Status Preview Updated
halo-docs ✅ Ready (Inspect) Visit Preview Dec 15, 2022 at 4:11PM (UTC)

@f2c-ci-robot f2c-ci-robot bot requested review from guqing and QuentinHsu December 9, 2022 04:18
@ruibaby
Copy link
Member Author

ruibaby commented Dec 12, 2022

@halo-dev/sig-docs

JohnNiang
JohnNiang reviewed Dec 13, 2022
View reviewed changes
Copy link
Member

@JohnNiang JohnNiang left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

通过预览链接无法在 2.0 的文档中看到 Docker 环境变量表格。

@JohnNiang
Copy link
Member

目前好像只为 Docker Compose 部署提供了环境变量的描述，建议 Docker 部署的也加上。

对了，接下来将支持额外两种配置方式：

@ruibaby
Copy link
Member Author

ruibaby commented Dec 14, 2022

对了，接下来将支持额外两种配置方式：

命令行参数的形式配置 Halo，可参考 https://github.com/halo-dev/halo/pull/2942。
配置文件的形式配置 Halo，可参考 https://github.com/halo-dev/halo/pull/2935。

这种都需要补充到文档上吗？

@JohnNiang
Copy link
Member

这种都需要补充到文档上吗？

应该是需要的，不过不在当前 PR 做这件事情。

@ruibaby
Copy link
Member Author

ruibaby commented Dec 14, 2022 •
edited
Loading

这种都需要补充到文档上吗？

应该是需要的，不过不在当前 PR 做这件事情。

如果三种方式都需要提供的话，可能得好好考虑一下文档结构，不然很可能造成一定程度的理解问题。

关于外置配置文件和命令行参数形式的配置的文档，可以先提交一个 issue。

@ruibaby
Copy link
Member Author

ruibaby commented Dec 15, 2022

目前好像只为 Docker Compose 部署提供了环境变量的描述，建议 Docker 部署的也加上。

已补充。

/cc @halo-dev/sig-docs

JohnNiang
JohnNiang approved these changes Dec 15, 2022
View reviewed changes
Copy link
Member

@JohnNiang JohnNiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@f2c-ci-robot
Copy link

f2c-ci-robot bot commented Dec 15, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JohnNiang

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@f2c-ci-robot f2c-ci-robot bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 15, 2022
guqing
guqing reviewed Dec 16, 2022
View reviewed changes
Copy link
Member

@guqing guqing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@f2c-ci-robot f2c-ci-robot bot added the lgtm Indicates that a PR is ready to be merged. label Dec 16, 2022
@f2c-ci-robot f2c-ci-robot bot merged commit dcb7a89 into halo-dev:main Dec 16, 2022
@ruibaby ruibaby deleted the docs/refine-docker-env-description branch December 17, 2022 03:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@guqing guqing guqing left review comments

@JohnNiang JohnNiang JohnNiang approved these changes

@QuentinHsu QuentinHsu Awaiting requested review from QuentinHsu

Assignees

@guqing guqing

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ruibaby @JohnNiang @guqing