Closed Bug 852422 Opened 8 years ago Closed 8 years ago

Update documentation for ManifestDestiny

Categories

(Testing :: Mozbase, defect)

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: k0scist, Assigned: wlach)

Details

Attachments

(1 file)

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.
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.
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.
(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.
This mostly just removes references to the wiki page. I snuck in some more minor cleanup of the documentation.
Assignee: nobody → wlachance
Attachment #726773 - Flags: review?(jhammel)
Comment on attachment 726773 [details] [diff] [review]
Update manifestdestiny documentation

Thanks, Will.  Any "snuck in" improvements very much appreciated
Attachment #726773 - Flags: review?(jhammel) → review+
Should we kill most of the wiki page after this lands?  Again, I'd remove but I don't have that kind of power.
(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
Status: NEW → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
Thanks, Will!
You need to log in before you can comment on or make changes to this bug.