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

Add docker things for documentation #2020

Merged
merged 3 commits into from
Oct 11, 2017
Merged

Add docker things for documentation #2020

merged 3 commits into from
Oct 11, 2017

Conversation

tcoupin
Copy link
Contributor

@tcoupin tcoupin commented Aug 28, 2017

Description

Add docs target to makefile to test documentation with docker.

docs.Dockerfile Outdated
&& rm -rf /var/cache/apk/*

RUN pip install mkdocs \
&& pip install mkdocs-bootswatch \
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you use pip install --user -r requirements.txt like in the .travis.yml and .semaphoreci/setup.sh?

CONTRIBUTING.md Outdated
$ make docs
docker build -t traefik-docs -f docs.Dockerfile .
# […]
docker run --rm -v /mnt/Data/workspace/github/tcoupin/traefik:/mkdocs -p 8000:8000 traefik-docs mkdocs serve
Copy link
Contributor

Choose a reason for hiding this comment

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

/mnt/Data/workspace/github/tcoupin/traefik -> /home/user/go/github/containous/treafik

@ldez
Copy link
Contributor

ldez commented Sep 28, 2017

@tcoupin any news?

@tcoupin
Copy link
Contributor Author

tcoupin commented Sep 28, 2017

Sorry, new home, new job => no time :)
I have amended my commit. It's ok for you ?

Copy link
Member

@juliens juliens left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@juliens juliens left a comment

Choose a reason for hiding this comment

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

typo

CONTRIBUTING.md Outdated
$ make docs
docker build -t traefik-docs -f docs.Dockerfile .
# […]
docker run --rm -v /home/user/go/github/containous/treafik:/mkdocs -p 8000:8000 traefik-docs mkdocs serve
Copy link
Member

Choose a reason for hiding this comment

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

treafik => traefik

@tcoupin
Copy link
Contributor Author

tcoupin commented Oct 3, 2017

Too fast ctrl-c ctrl-v... Fix made

Copy link
Member

@juliens juliens left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@nmengin nmengin left a comment

Choose a reason for hiding this comment

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

@tcoupin Many thanks for this PR.

Just a suggestion about your Dockerfile.

docs.Dockerfile Outdated

WORKDIR /mkdocs
COPY requirements.txt /mkdocs

Copy link
Contributor

@nmengin nmengin Oct 10, 2017

Choose a reason for hiding this comment

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

You don't have to create mkdocs directory with the instruction RUN mkdir /mkdocs, the instruction COPY requirements.txt /mkdocs/ creates the directory automatically.

Copy link
Contributor

@nmengin nmengin left a comment

Choose a reason for hiding this comment

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

LGTM 📖 🐳 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants