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

update Readmd.md #236

Merged
merged 1 commit into from
Jul 18, 2022
Merged

update Readmd.md #236

merged 1 commit into from
Jul 18, 2022

Conversation

yxxhero
Copy link
Member

@yxxhero yxxhero commented Jul 18, 2022

update Readmd.md

Signed-off-by: yxxhero aiopsclub@163.com

@yxxhero
update Readmd.md
b2f780b 
Signed-off-by: yxxhero <aiopsclub@163.com>
mumoshu
mumoshu reviewed Jul 18, 2022
View reviewed changes
Copy link
Contributor

@mumoshu mumoshu left a comment

Choose a reason for hiding this comment

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

Hey. Where do all the config and instalation docs go?

@yxxhero
Copy link
Member Author

yxxhero commented Jul 18, 2022

@mumoshu helmfile.readthedocs.io

@mumoshu
Copy link
Contributor

mumoshu commented Jul 18, 2022 •
edited

@yxxhero Thanks! But I don't get it. The section like https://helmfile.readthedocs.io/en/latest/#configuration is generated from the README. If you removed it from the README, the equivalent section in the doc site would also gets removed.

@yxxhero
Copy link
Member Author

yxxhero commented Jul 18, 2022

The section like https://helmfile.readthedocs.io/en/latest/#configuration is generated from the docs/index.md.

@yxxhero
Copy link
Member Author

yxxhero commented Jul 18, 2022

@mumoshu You can see mkdoc.yaml

@mumoshu
Copy link
Contributor

mumoshu commented Jul 18, 2022 •
edited

@yxxhero Ah, sorry! I didn't realize that you changed the dosc/index.md from a symlink to a copy of the current README.md in #224 (is that correct?

@yxxhero
Copy link
Member Author

yxxhero commented Jul 18, 2022

@mumoshu yes. haha

mumoshu
mumoshu approved these changes Jul 18, 2022
View reviewed changes
Copy link
Contributor

@mumoshu mumoshu left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@mumoshu mumoshu merged commit b3f4b78 into main Jul 18, 2022
@mumoshu mumoshu deleted the update_readmd branch July 18, 2022 05:06
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mumoshu mumoshu mumoshu approved these changes

@itscaro itscaro Awaiting requested review from itscaro itscaro is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@yxxhero @mumoshu