Documentation errors in the Mozmill README.md

RESOLVED WONTFIX

Status

RESOLVED WONTFIX
6 years ago
2 years ago

People

(Reporter: bsilverberg, Assigned: bsilverberg)

Tracking

Details

Attachments

(1 attachment)

(Assignee)

Description

6 years ago
A number of links at https://github.com/mozilla/mozmill/blob/master/mozmill/README.md are 404s.  A pull request fixing these issues has been submitted at https://github.com/mozilla/mozmill/pull/108.
Bob, please install the following add-on and attach the link as attachment.
Then ask for review from Jeff. Thanks.

https://addons.mozilla.org/en-US/firefox/addon/github-tweaks-for-bugzilla/versions/?page=1#version-1.9
Assignee: nobody → bob.silverberg
Status: NEW → ASSIGNED
(Assignee)

Comment 2

6 years ago
Created attachment 668498 [details]
Pointer to Github pull request: https://github.com/mozilla/mozmill/pull/108

Pointer to Github pull-request
(Assignee)

Updated

6 years ago
Attachment #668498 - Flags: review?(jhammel)

Comment 3

6 years ago
Ah, I now understand why this is "wrong".  In fact, it isn't wrong, as such: the previous assumption for canonical documentation is MDN and the files are intended to be mirrored there.  See https://github.com/mozilla/mozmill/blob/master/docs.manifest . We have held off on doing this until mozmill 2 was canon.  Also, now, AFAIK there isn't yet a RESTful API to mirror to MDN currently.

The short story is: both ways can't work as is.  I'm going to unassign myself from review, as what we actually want to do here isn't really my decision to make.  If it was my decision to make, I would keep the current broken links since MDN is intended to be the canonical source of documentation and WONTFIX this bug.
Group: mozilla-corporation-confidential

Updated

6 years ago
Group: mozilla-corporation-confidential

Updated

6 years ago
Attachment #668498 - Flags: review?(jhammel)

Comment 4

6 years ago
Bob, I appreciate you helping out here, and what you did is correct for nearly every github hosted project out there. But, Mozilla has a policy of putting all our docs on our developer site (developer.mozilla.org) and so that's where mozmill's documentation live. And that's what the documentation system inside the repo are supposed to work with. Because the software at developer.mozilla.org has changed, this automatic mirroring solution we had won't work,and we have embarked on another docs effort at: http://davehunt.github.com/automation-documentation/overview.html

We aim to fix the docs there and do one massive upload to developer.m.o and then keep the canonical docs up there while allowing the detailed source level docs to live with the source. 

So, we're in the middle of this transition and what you found and saw as a bug is a bug, but we're solving it in a different way. So, we're going to keep on our existing path, and we're not going to take this pull request. I'm sorry about that.  I did see that you submitted some other fixes though, and I'm super excited to check out those patches. THanks for your contributions.

Resolving WONTFIX as it is a bug, but we're not solving it this way.
Status: ASSIGNED → RESOLVED
Last Resolved: 6 years ago
Resolution: --- → WONTFIX
(Assignee)

Comment 5

6 years ago
Thanks for the detailed explanation, Clint. I do appreciate it.
Product: Testing → Testing Graveyard
You need to log in before you can comment on or make changes to this bug.