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: create zh global and dns docs #243

Merged
merged 5 commits into from
Jul 27, 2023
Merged

docs: create zh global and dns docs #243

merged 5 commits into from
Jul 27, 2023

Conversation

troubadour-hell
Copy link
Contributor

@troubadour-hell troubadour-hell commented Jul 25, 2023

Background

Translated the most difficult part to understand.

Checklist

Full changelogs

  • docs: add zh global and dns docs

Issue reference

NA

Test Result

NA

@troubadour-hell troubadour-hell requested a review from a team as a code owner July 25, 2023 04:42
@mzz2017
Copy link
Contributor

mzz2017 commented Jul 25, 2023

Good job!

Feel free to tell me once it is ready to review.

@troubadour-hell
Copy link
Contributor Author

Good job!

Feel free to tell me once it is ready to review.

It's ready.

Copy link
Contributor

@piyoki piyoki left a comment

Choose a reason for hiding this comment

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

Looks great in general. However, we do NOT have docs/en/configuration/global.md ATM. Would you like to create one, please?

@troubadour-hell
Copy link
Contributor Author

Looks great in general. However, we do NOT have ATM. Would you like to create one, please?docs/en/configuration/global.md

It is translated from part of example.dae. I have no idea if it is necessary to create such a file.

docs/zh/configuration/global.md Outdated Show resolved Hide resolved
@piyoki piyoki changed the title create zh global and dns docs docs: create zh global and dns docs Jul 26, 2023
@piyoki
Copy link
Contributor

piyoki commented Jul 26, 2023

If we add global.md to /docs/, we will need to maintain two copies of config.example, which drastically increases maintenance overheads. Hence, I propose to get rid of global.md. cc @mzz2017 @troubadour-hell

@piyoki piyoki added the documentation Improvements or additions to documentation label Jul 26, 2023
@piyoki piyoki requested a review from mzz2017 July 26, 2023 01:19
@piyoki
Copy link
Contributor

piyoki commented Jul 27, 2023

If we add global.md to /docs/, we will need to maintain two copies of config.example, which drastically increases maintenance overheads. Hence, I propose to get rid of global.md. cc @mzz2017 @troubadour-hell

@mzz2017 Any thoughts on this?

@mzz2017
Copy link
Contributor

mzz2017 commented Jul 27, 2023

@yqlbu We can put it in a discussion (as community-maintained version) and refer it in example.dae.

@piyoki
Copy link
Contributor

piyoki commented Jul 27, 2023

@yqlbu We can put it in a discussion (as community-maintained version) and refer it in example.dae.

Refer to #245 cc @troubadour-hell

Copy link
Contributor

@mzz2017 mzz2017 left a comment

Choose a reason for hiding this comment

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

lgtm

@piyoki piyoki merged commit 5836edb into daeuniverse:main Jul 27, 2023
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants