852422 - Update documentation for ManifestDestiny

Status: RESOLVED FIXED

(Testing :: Mozbase, defect)

Description

[Jeff Hammel]

I noted today that
https://wiki.mozilla.org/Auto-tools/Projects/ManifestDestiny is
obselete.  We should look at this page and make sure that everything
lives at
https://mozbase.readthedocs.org/en/latest/manifestdestiny.html
. https://mozbase.readthedocs.org/en/latest/manifestdestiny.html also
has an obselete link to Projects/Manifest:
https://mozbase.readthedocs.org/en/latest/manifestdestiny.html#developing-manifestdestiny
; this should be removed.

In general the documentation should be audited for correctness and
adequacy, but moving into a brave new manifest world at least these
glaring flaws should be fixed.

Comment 1

[William Lachance (:wlach) (use needinfo!)]

Yup, sounds good. Are you planning to take care of this?

I would also like to update the documentation to focus more on the API and how to use manifestdestiny in a practical context, but we can cover that some other time.

Comment 2

[Jeff Hammel]

Probably eventually, but since my backlog grows faster than I can clear it, I have no particular estimate as to when.

Yeah, the documentation ain't great.

Comment 3

[William Lachance (:wlach) (use needinfo!)]

(In reply to Jeff Hammel [:jhammel] from comment #2)
> Probably eventually, but since my backlog grows faster than I can clear it,
> I have no particular estimate as to when.
> 
> Yeah, the documentation ain't great.

I had a look at the page and I don't see any essential information that isn't covered by the current ManifestDestiny documentation. I think the only thing to do is remove references to that wiki page.

Comment 4

[William Lachance (:wlach) (use needinfo!)]

Attachment: Update manifestdestiny documentation

This mostly just removes references to the wiki page. I snuck in some more minor cleanup of the documentation.

Comment 5

[Jeff Hammel]

Comment on attachment 726773 [details] [diff] [review]
Update manifestdestiny documentation

Thanks, Will.  Any "snuck in" improvements very much appreciated

Comment 6

[Jeff Hammel]

Should we kill most of the wiki page after this lands?  Again, I'd remove but I don't have that kind of power.

Comment 7

[William Lachance (:wlach) (use needinfo!)]

Pushed: https://github.com/mozilla/mozbase/commit/3707de502376996111d97e76e1a81597aea9f9ef

Comment 8

[William Lachance (:wlach) (use needinfo!)]

(In reply to Jeff Hammel [:jhammel] from comment #6)
> Should we kill most of the wiki page after this lands?  Again, I'd remove
> but I don't have that kind of power.

I thought this was a good idea, so I did it:

https://wiki.mozilla.org/Auto-tools/Projects/ManifestDestiny

Comment 9

[Jeff Hammel]

Thanks, Will!