Skip to content
This repository has been archived by the owner on Dec 7, 2023. It is now read-only.

use mkdocs instead #565

Merged
merged 1 commit into from
Apr 10, 2020
Merged

use mkdocs instead #565

merged 1 commit into from
Apr 10, 2020

Conversation

dholbach
Copy link
Contributor

@dholbach dholbach commented Mar 23, 2020 •
edited
Loading

https://test-ignite.readthedocs.io/en/latest/ is what the docs would look like (no webhook to build docs automatically set up).

@dholbach dholbach requested a review from luxas March 23, 2020 15:26
@dholbach dholbach force-pushed the move-to-mkdocs branch 2 times, most recently from 5f8451a to c3bf69e Compare March 24, 2020 08:57
@dholbach
Copy link
Contributor Author

@luxas @chanwit @stealthybox I'd appreciate a look over https://test-ignite.readthedocs.io/ and this PR.

Things that are hard to do with mkdocs are automatic toctrees. I even attempted to use jinja2 macros, but didn't get anywhere. Everything else becomes easier. The navbar on the the left is still tweakable - right now it's auto-generated.

@dholbach dholbach changed the title WIP: use mkdocs instead use mkdocs instead Mar 27, 2020
@dholbach dholbach marked this pull request as ready for review March 27, 2020 09:38
@dholbach dholbach requested a review from twelho as a code owner March 27, 2020 09:38
@dholbach
Copy link
Contributor Author

Not sure what https://circleci.com/gh/weaveworks/ignite/1115 is about. I might need help to fix it.

@dholbach dholbach force-pushed the move-to-mkdocs branch 2 times, most recently from 4d1f161 to e9ff974 Compare April 1, 2020 16:09
stealthybox
stealthybox reviewed Apr 1, 2020
View reviewed changes
CHANGELOG.md
@@ -176,7 +176,7 @@ for binary in ignite ignited; do
done
```

A more throughout installation guide is available here: https://ignite.readthedocs.io/en/latest/installation.html
A more throughout installation guide is available here: https://ignite.readthedocs.io/en/latest/installation
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a way to redirect the old link?
It's present in every GitHub release currently:
https://github.com/weaveworks/ignite/releases

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't quite know how to do that. Can we change the release announcements to point to /en//rest-of-link.html?

@dholbach
Copy link
Contributor Author

dholbach commented Apr 3, 2020

Shall I split up the PR into 1) move to mkdocs and 2) add link-checking?

@dholbach
Copy link
Contributor Author

dholbach commented Apr 6, 2020

Shall I split the mkdocs move part of the PR out and move the link-checking bits to a separate PR?

@dholbach dholbach mentioned this pull request Apr 8, 2020
Merged
@dholbach
Copy link
Contributor Author

dholbach commented Apr 8, 2020

Moving the checking of links to #573

luxas
luxas approved these changes Apr 10, 2020
View reviewed changes
Copy link
Contributor

@luxas luxas left a comment

Choose a reason for hiding this comment

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

This looks awesome @dholbach! I'm all for it 🔥

@luxas luxas added this to the v0.7.0 milestone Apr 10, 2020
@stealthybox stealthybox merged commit 321b39a into master Apr 10, 2020
@stealthybox stealthybox deleted the move-to-mkdocs branch April 10, 2020 15:32
@gaby gaby mentioned this pull request Mar 10, 2021
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@luxas luxas luxas approved these changes

@chanwit chanwit Awaiting requested review from chanwit

@twelho twelho Awaiting requested review from twelho

@stealthybox stealthybox Awaiting requested review from stealthybox

Assignees

@stealthybox stealthybox

Labels
None yet
Projects
None yet
Milestone
v0.7.0
Development

Successfully merging this pull request may close these issues.
3 participants
@dholbach @stealthybox @luxas