[marionette-js-client] Publish the document on the Web

RESOLVED FIXED

Status

Testing
JSMarionette
RESOLVED FIXED
4 years ago
4 years ago

People

(Reporter: evanxd, Unassigned)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment)

(Reporter)

Description

4 years ago
We could publish the document on the Web.
And everyone could read it very easily, not only read it in local with "make doc-server".
(Reporter)

Comment 1

4 years ago
Hi guys,

We could publish the doc in gh-pages branch in GitHub, like this:
http://evanxd.github.io/marionette_js_client/out/

It's a easy way, and it could keep the doc sync with code.
And we could add a new command in Makefile for publishing the doc.
For example, "make publish-doc".

How do you guys think?
Flags: needinfo?
(Reporter)

Updated

4 years ago
Flags: needinfo?
(Reporter)

Updated

4 years ago
Flags: needinfo?(jlal)
(Reporter)

Updated

4 years ago
Flags: needinfo?(gaye)
(Reporter)

Updated

4 years ago
Flags: needinfo?(mike)
Hey Evan,

If I understand you correctly, we already have a solution for this. Have you seen the `doc-publish` target?

https://github.com/mozilla-b2g/marionette-js-client/blob/3483cb052ca121f5948c6cf86110fc7f0712973f/Makefile#L22-L32
Flags: needinfo?(mike)
(Reporter)

Comment 3

4 years ago
Hi Mike,

Sorry, I didn't see the 'doc-publish' before.
So cool!
We could read the doc in http://mozilla-b2g.github.io/marionette-js-client/api-docs/.

But the 'doc-publish' command might have issue with .gitignore file in
https://github.com/mozilla-b2g/marionette-js-client/blob/master/.gitignore#L4.
For now, after we do 'doc-publish', it will show 'no files added'.
We could fix that here.

And the doc in GitHub seems be out of date. So we should do 'doc-publish' each time after we update the code affected the doc, right?
(Reporter)

Comment 4

4 years ago
Created attachment 803482 [details]
Pull request

Hi Mike,

Please help review the patch.
Thanks. :)
Attachment #803482 - Flags: review?(mike)
(Reporter)

Updated

4 years ago
Flags: needinfo?(jlal)
Flags: needinfo?(gaye)
(Reporter)

Comment 5

4 years ago
master: https://github.com/mozilla-b2g/marionette-js-client/commit/f21fb274a3b0809d1b5a2164fb79a19766c0e758
r=lightsofapollo
Status: NEW → RESOLVED
Last Resolved: 4 years ago
Resolution: --- → FIXED
(Reporter)

Updated

4 years ago
Attachment #803482 - Flags: review?(mike)
You need to log in before you can comment on or make changes to this bug.