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

Fix link to CHANGELOG #41

Closed
wants to merge 1 commit into from
Closed

Fix link to CHANGELOG #41

wants to merge 1 commit into from

Conversation

koppor
Copy link
Contributor

@koppor koppor commented Jul 5, 2018

keep a changelog really recommends to have a CHANGELOG.md file in the root of the repository. This is very common and helps open source people finding the information in new repositories easily.

I agree that it is important to have it nicely rendered at http://ctongfei.github.io/progressbar/changelog/.

In commit fdf2baa, the changelog was moved to docs/ and renamed to changelog.md. This PR fixes the link.

I would recommend to revert the move. And then either

  1. maintain the file twice (CHANGELOG.md and docs/changelog.md)
  2. Create a script copying the CHANGELOG.md to docs/changelog.md during some gh-pages deployment step. This is possible by using CircleCI and some magic shell script. See https://github.com/latextemplates/LNCS/blob/d44efccf2a3b6623733311b5b2860589bc175cc4/.circleci/config.yml#L26 for a quick example.

@ctongfei
Copy link
Owner

ctongfei commented Jul 5, 2018

Thanks. I moved the changelog from docs/changelog.md to the original CHANGELOG.md at the home directory, and created a symlink in docs/. This does not seem to influence mkdocs build -- the documentation site could still be rendered correctly.

@ctongfei ctongfei closed this Jul 5, 2018
@koppor koppor deleted the patch-1 branch July 6, 2018 05:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants