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 #148 single source of truth for the changelog #160

Merged
merged 3 commits into from
Jan 17, 2019

Conversation

johnraz
Copy link
Collaborator

@johnraz johnraz commented Jan 17, 2019

This fixes #148 by making CHANGELOG.md the only source of truth for the doc.
It is achieved by symlinking it in the docs folder.

I added a docker utility to work on the doc + documentation in the README on how to build the doc (doc for doc 🙄)

Also fixed an easy deprecation warning in mkdocs.

-w $MOUNT_FOLDER \
-p $MKDOCS_DEV_PORT:$MKDOCS_DEV_PORT \
-e MKDOCS_DEV_ADDR="$MKDOCS_DEV_ADDR:$MKDOCS_DEV_PORT" \
squidfunk/mkdocs-material:3.2.0 $*
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just making sure, $* is intended yes?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes sure it is :-)

@sphrak
Copy link
Collaborator

sphrak commented Jan 17, 2019

@johnraz it looks good Once this has been merged I can port it to the keep-a-change-log format discussed previously in #161 👍


It will run mkdocs in a [docker](https://www.docker.com/) container.

Running the script without any params the `serve` command.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This sentence doesn't quite make sense to me grammatically 🤔


Running the script without any params the `serve` command.
The server is exposed on localhost on port 8000.
If you want to configure port serve is exposed on you can use the
Copy link
Collaborator

Choose a reason for hiding this comment

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

Here I'm also not sure.. should it be "if you want to configure a port where the server is exposed on?

@belugame
Copy link
Collaborator

awesome work! thank you very much! :)

@belugame belugame merged commit 20efd54 into jazzband:develop Jan 17, 2019
@johnraz johnraz deleted the Issue148-SingleChangelog branch January 18, 2019 12:18
@johnraz
Copy link
Collaborator Author

johnraz commented Jan 18, 2019

I will look at the grammar issues, did that while speaking to my wife, I may have missed some stuff 😄

dontexit pushed a commit to dontexit/django-rest-knox that referenced this pull request Jan 24, 2024
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.

3 participants