cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dmitry Blotsky (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (CB-13338) How does the build process work?
Date Wed, 27 Sep 2017 17:12:00 GMT

    [ https://issues.apache.org/jira/browse/CB-13338?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16182907#comment-16182907
] 

Dmitry Blotsky edited comment on CB-13338 at 9/27/17 5:11 PM:
--------------------------------------------------------------

Responses in order:
1. The Make process was for me only. It's a mirror of the gulpfile. You can remove it (but
if it doesn't bother you, please keep it).
2. Some Jekyll plugins need Python. Not sure which ones. It installs on Windows in like 10
min.
3. Node.js is needed for the whole build process, including Gulp. See the files in {{tools/bin}}.
4. Many things, on which serve/watch/build rely. Run {{./node_modules/.bin/gulp}}, and it
will document itself.
5. Many. Not sure if they need to be documented, because you'd need to read the code to change
them.
6. See {{conf/_dev.yml}} and {{conf/_prod.yml}}. Essentially, the dev build doesn't build
all docs versions, and is faster.
7. The downloaded files are all listed in {{www/_data/fetched-files.yml}}, and are downloaded
by {{tools/bin/fetch_docs.js}}.
8. There is nothing done about translations right now. Someone has to develop that process.


was (Author: dblotsky):
Responses in order:
1. The Make process was for me only. It's a mirror of the gulpfile. You can remove it (but
if it doesn't bother you, please keep it).
2. Some Jekyll plugins need Python. Not sure which ones. It installs on Windows in like 10
min.
3. Node.js is needed for the whole build process, including Gulp. See the files in {{tools/bin}}.
4. Yes. Serve/watch/build rely on them. Run {{./node_modules/.bin/gulp}}, and it will document
itself.
5. Many. Not sure if they need to be documented, because you'd need to read the code to change
them.
6. See {{conf/_dev.yml}} and {{conf/_prod.yml}}. Essentially, the dev build doesn't build
all docs versions, and is faster.
7. The downloaded files are all listed in {{www/_data/fetched-files.yml}}, and are downloaded
by {{tools/bin/fetch_docs.js}}.
8. There is nothing done about translations right now. Someone has to develop that process.

> How does the build process work?
> --------------------------------
>
>                 Key: CB-13338
>                 URL: https://issues.apache.org/jira/browse/CB-13338
>             Project: Apache Cordova
>          Issue Type: Sub-task
>          Components: cordova-docs
>            Reporter: Jan Piotrowski (Sujan)
>
> Per https://github.com/apache/cordova-docs/blob/master/README.md#building and https://github.com/apache/cordova-docs/blob/master/README.md#developing
the build process of the website is handled by `gulp`.
> https://github.com/apache/cordova-docs/blob/master/README.md#installing tells us to install
_Ruby_, _python_, _Node.js_, the _dependencies _for both Ruby and Node, and optionally _Make_.
> From looking at `www` I know the website is _actually_ a Jekyll website.
> This leads to a very confused me and several questions:
> # How does the build process with Make work? Is this documented?
> # What is python required for?
> # What is node.js required for? gulp?
> # What does the gulp thing actually do? The README only mentions serve, watch, build
- but the gulpfile contains _so_ much more.
> # What workflows or processes are "hidden" in the gulpfile that should better be documented?
> # What is the difference between PROD and DEV in this build process?
> # How does the fetching of external docs work?
> # Is there anything about translations in there?



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org


Mime
View raw message