Skip to content
This repository was archived by the owner on Mar 31, 2023. It is now read-only.

move to mkdocs #153

Merged
merged 1 commit into from
Mar 25, 2020
Merged

move to mkdocs #153

merged 1 commit into from
Mar 25, 2020

Conversation

dholbach
Copy link
Contributor

Following some of our other projects, looking at mkdocs for wksctl too.

To test it, run

pip3 install -r docs/requirements.txt
mkdocs serve

I can point http://wksctl.rtfd.io/ to use this branch for testing too.

@dholbach dholbach requested review from chanwit and fbarl March 24, 2020 10:37
@dholbach dholbach self-assigned this Mar 24, 2020
@dholbach
Copy link
Contributor Author

Suggested new docs are: https://test-wksctl.readthedocs.io/

@dholbach dholbach requested review from foot and jrryjcksn March 24, 2020 11:32
Copy link
Contributor

@fbarl fbarl left a comment

Choose a reason for hiding this comment

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

Thanks for this PR @dholbach, visually it's a great improvement IMO! 🎉

I went through the code as well and put a couple of small comments. I'll approve but please address the comments and try to get @bia's stamp as well before merging :)

@dholbach dholbach requested a review from bia March 25, 2020 14:07
@bia
Copy link
Contributor

bia commented Mar 25, 2020

Looks great! Thanks @dholbach!

What do you guys think about making the navbar white to match eksctl?

@dholbach
Copy link
Contributor Author

I personally feel the all-white is a bit dull. Could we use other colours that make sense? What does everybody else think?

@dholbach
Copy link
Contributor Author

I stole the navbar colours and made a variation of it after reading https://github.com/openfaas/docs/blob/master/mkdocs.yml and https://github.com/openfaas/docs/blob/master/docs/stylesheets/extra.css

@bia
Copy link
Contributor

bia commented Mar 25, 2020

Your version is more beautiful. Let's just keep it unchanged and merge. :)

Copy link
Contributor

@jrryjcksn jrryjcksn left a comment

Choose a reason for hiding this comment

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

Very nice! A big improvement.

@dholbach
Copy link
Contributor Author

Yes. Let's do any clean up and beautification in a new PR. Thanks for the reviews @bia and @fbarl ! <3

@dholbach dholbach merged commit 4d263a4 into master Mar 25, 2020
@dholbach dholbach deleted the move-to-mkdocs branch March 25, 2020 15:32
@dholbach
Copy link
Contributor Author

I deleted test-wksctl.rtfd.io.

D3nn pushed a commit that referenced this pull request May 8, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants