1027108 - switch fjord docs to use the mozilla sphinx theme

Status: RESOLVED FIXED

(Input :: General, defect)

Description

[Will Kahn-Greene [:willkg] ET needinfo? me]

There's a Mozilla Sphinx theme that we can use for the Fjord docs to make them look more Mozilla-y.

We should change the Fjord docs to use that theme.

The theme and instructions on using it are here:

https://github.com/mozilla/mozilla-sphinx-theme

Comment 1

[Will Kahn-Greene [:willkg] ET needinfo? me]

Making this a mentored bug and also marking it as a good first bug.

The instructions for switching the theme seem pretty straight forward. There shouldn't be any coding involved here.

If you're interested in working on this, add a comment to the bug or ping me on IRC (I'm willkg).

Comment 2

[Anna]

I'd like to have a go :)
Where do I start?

Comment 3

[Will Kahn-Greene [:willkg] ET needinfo? me]

The docs for Fjord are in the repository in the docs/ directory. So clone the repository and get the docs building.

After that, follow the instructions in the mozilla-sphinx-theme repository for setting up the theme.

Does that make sense?

Comment 4

[Anna]

Attachment: ChangeTheme.patch

Comment 5

[Will Kahn-Greene [:willkg] ET needinfo? me]

Awesome! Assigning this bug to you. I'll try to review this today.

Comment 6

[Will Kahn-Greene [:willkg] ET needinfo? me]

Oh, wait--this is a regular patch. Can you create a git commit patch? That'd be a lot easier to figure my way through.

Comment 7

[Anna]

I did use git commit & format-patch.

Comment 8

[Will Kahn-Greene [:willkg] ET needinfo? me]

Bah--sorry about that. I don't know what the hell I did, but I did something weird when I downloaded it the first time around.

This looks great--I'll merge it now. Thank you!

Comment 9

[Will Kahn-Greene [:willkg] ET needinfo? me]

Landed in master in https://github.com/mozilla/fjord/commit/6ecd0ce

Marking this as FIXED since once it lands in master it's done.

Adding whiteboard data so it shows up in my tracker.

Thank you again! If there are other things you want to work on, let me know. We hang out on #input on irc.mozilla.org if you want to drop in.

Comment 10

[Anna]

Could you suggest another bug please :)

Comment 11

[Mike Hoye [:mhoye]]

I love it. 

Anna - thanks for this. I'm going to needinfo Will to make sure he sees your question.

Comment 12

[Will Kahn-Greene [:willkg] ET needinfo? me]

Sent an email.

Comment 13

[Will Kahn-Greene [:willkg] ET needinfo? me]

Comment on attachment 8443929 [details] [diff] [review]
ChangeTheme.patch

Review of attachment 8443929 [details] [diff] [review]:
-----------------------------------------------------------------

I reviewed and applied this already. Forgot to update the attachment.