1628631 - https://docs.firefox-dev.tools/ is no longer updated

Status: RESOLVED FIXED

(DevTools :: Documentation, defect, P2)

Description

[Julian Descottes [:jdescottes]]

Removing the README.md file in Bug 1620078 broke the build.

Comment 1

[Julian Descottes [:jdescottes]]

Logs at https://travis-ci.org/github/firefox-devtools/docs/builds/672780168

I should be able to fix this by updating the GitBook config, but do we plan to decommission https://docs.firefox-dev.tools/ soon?

Comment 2

[Julian Descottes [:jdescottes]]

Attachment: Bug 1628631 - Add a README.md file to devtools/docs to fix gitbook build

Unless we plan to drop the gitbook version, we should avoid breaking the build.
GitBook relies on README.md to be available under the root folder. We can configure it to be a different filename, but it can't look in nested folders.

I just copied back the top content of index.rst. It's duplicating the content, but for now I don't see another option.

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/cc30645a502d
Add a README.md file to devtools/docs to fix gitbook build r=Honza

Comment 4

[Daniel Varga [:dvarga]]

https://hg.mozilla.org/mozilla-central/rev/cc30645a502d