switch fjord docs to use the mozilla sphinx theme



4 years ago
4 years ago


(Reporter: willkg, Assigned: Anna, Mentored)



(Whiteboard: u=dev c=docs p= s=input.2014q2 [good first bug])


(1 attachment)

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:

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).
Mentor: willkg@mozilla.com
Whiteboard: [mentor=willkg][good first bug]


4 years ago
Whiteboard: [mentor=willkg][good first bug] → [good first bug]

Comment 2

4 years ago
I'd like to have a go :)
Where do I start?
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

4 years ago
Created attachment 8443929 [details] [diff] [review]
Attachment #8443929 - Flags: review?(willkg)
Awesome! Assigning this bug to you. I'll try to review this today.
Assignee: nobody → ms.annaphilips
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

4 years ago
I did use git commit & format-patch.
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!
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.
Last Resolved: 4 years ago
Resolution: --- → FIXED
Whiteboard: [good first bug] → u=dev c=docs p= s=input.2014q2 [good first bug]

Comment 10

4 years ago
Could you suggest another bug please :)

Comment 11

4 years ago
I love it. 

Anna - thanks for this. I'm going to needinfo Will to make sure he sees your question.
Flags: needinfo?(willkg)
Sent an email.
Flags: needinfo?(willkg)
Comment on attachment 8443929 [details] [diff] [review]

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

I reviewed and applied this already. Forgot to update the attachment.
Attachment #8443929 - Flags: review?(willkg) → review+
You need to log in before you can comment on or make changes to this bug.