cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CB-13955) No mention of 'Make' command running in 'developing-the-website' section
Date Tue, 17 Apr 2018 01:44:00 GMT

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

ASF GitHub Bot commented on CB-13955:
-------------------------------------

stevengill closed pull request #811: CB-13955 No mention of 'Make' command running in 'developing-the-website'
section
URL: https://github.com/apache/cordova-docs/pull/811
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/Makefile b/Makefile
deleted file mode 100644
index 23a2fa90d..000000000
--- a/Makefile
+++ /dev/null
@@ -1,314 +0,0 @@
-# Function Reference:
-# 	https://www.gnu.org/software/make/manual/html_node/Text-Functions.html
-#  	https://www.gnu.org/software/make/manual/html_node/File-Name-Functions.html
-# Variable Reference:
-# 	https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html
-
-# Makefile's own config
-ifeq ($(OS),Windows_NT)
-WINDOWS=1
-endif
-
-ifdef WINDOWS
-SHELL  = cmd
-JEKYLL = bundle.bat exec jekyll
-CAT    = type
-LS     = ls
-else
-SHELL  = sh
-JEKYLL = bundle exec jekyll
-CAT    = cat
-LS     = ls
-endif
-
-# macros
-slugify       = $(subst /,_,$(subst .,-,$(1)))
-slug2language = $(subst /,,$(dir $(subst _,/,$(1))))
-slug2version  = $(subst -,.,$(notdir $(subst _,/,$(1))))
-
-ifdef WINDOWS
-copydir = xcopy "$(subst /,\,$(1))" "$(subst /,\,$(2))" /E /I
-else
-copydir = cp -r $(1) $(2)
-endif
-
-ifdef WINDOWS
-copyfile = copy "$(subst /,\,$(1))" "$(subst /,\,$(2))"
-else
-copyfile = cp $(1) $(2)
-endif
-
-ifdef WINDOWS
-makedir = mkdir $(subst /,\,$(1))
-else
-makedir = mkdir -p $(1)
-endif
-
-ifdef WINDOWS
-printfile = type $(subst /,\,$(1))
-else
-printfile = cat $(1)
-endif
-
-ifdef WINDOWS
-RM = cmd /C del /Q /F $(subst /,\,$(1))
-RMDIR  = cmd /C rmdir /S /Q $(subst /,\,$(1))
-else
-RM = rm -f $(1)
-RMDIR = rm -rf $(1)
-endif
-
-# constants
-EMPTY =
-SPACE = $(EMPTY) $(EMPTY)
-COMMA = ,
-
-VERSION_VAR_NAME = latest_docs_version
-
-# paths and files
-BIN_DIR      = tools/bin
-NODE_BIN_DIR = ./node_modules/.bin
-
-SRC_DIR    = www
-DEV_DIR    = build-dev
-PROD_DIR   = build-prod
-CONFIG_DIR = conf
-
-DOCS_DIR         = $(SRC_DIR)/docs
-DATA_DIR         = $(SRC_DIR)/_data
-TOC_DIR          = $(DATA_DIR)/toc
-STATIC_DIR       = $(SRC_DIR)/static
-CSS_SRC_DIR      = $(STATIC_DIR)/css-src
-CSS_DEST_DIR     = $(STATIC_DIR)/css
-PLUGINS_SRC_DIR  = $(STATIC_DIR)/plugins
-PLUGINS_DEST_DIR = $(STATIC_DIR)/js
-
-# executables
-NODE       = node
-GULP       = $(NODE_BIN_DIR)/gulp
-LESSC      = $(NODE_BIN_DIR)/lessc
-SASSC      = $(NODE_BIN_DIR)/node-sass
-BROWSERIFY = $(NODE_BIN_DIR)/browserify
-UGLIFY     = $(NODE_BIN_DIR)/uglifyjs
-
-# replace slashes in executables on Windows
-ifdef WINDOWS
-GULP       := $(subst /,\,$(GULP))
-LESSC      := $(subst /,\,$(LESSC))
-SASSC      := $(subst /,\,$(SASSC))
-BROWSERIFY := $(subst /,\,$(BROWSERIFY))
-UGLIFY     := $(subst /,\,$(UGLIFY))
-endif
-
-# existing files
-MAIN_CONFIG         = $(CONFIG_DIR)/_config.yml
-DEV_CONFIG          = $(CONFIG_DIR)/_dev.yml
-PROD_CONFIG         = $(CONFIG_DIR)/_prod.yml
-DOCS_EXCLUDE_CONFIG = $(CONFIG_DIR)/_nodocs.yml
-FETCH_CONFIG        = $(DATA_DIR)/fetched-files.yml
-REDIRECTS_FILE      = $(DATA_DIR)/redirects.yml
-PLUGINS_SRC         = $(PLUGINS_SRC_DIR)/app.js
-VERSION_FILE        = VERSION
-FETCH_SCRIPT        = $(BIN_DIR)/fetch_docs.js
-
-# NOTE:
-#      the .scss files are separate because they combine into MAIN_STYLE_FILE,
-#      which includes them on its own, and the SCSS compiler takes care of them;
-#      because of this, there is also no .scss -> .css pattern rule
-ifdef WINDOWS
-PWD = $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
-SCSS_SRC   = $(subst $(PWD),,$(subst \,/,$(shell cd $(CSS_SRC_DIR) && dir *.scss
/S /B)))
-STYLES_SRC = $(subst $(PWD),,$(subst \,/,$(shell cd $(CSS_SRC_DIR) && dir *.less
*.css /S /B)))
-else
-SCSS_SRC   = $(shell find $(CSS_SRC_DIR) -name "*.scss")
-STYLES_SRC = $(shell find $(CSS_SRC_DIR) -name "*.less" -or -name "*.css")
-endif
-
-LANGUAGES = $(shell $(LS) $(DOCS_DIR))
-
-LATEST_DOCS_VERSION = $(strip $(shell $(CAT) $(VERSION_FILE)))
-NEXT_DOCS_VERSION   = $(shell $(NODE) $(BIN_DIR)/nextversion.js $(LATEST_DOCS_VERSION))
-
-NEXT_DOCS_VERSION_SLUG   = $(call slugify,$(NEXT_DOCS_VERSION))
-
-DEV_DOCS      = $(addprefix $(DOCS_DIR)/,$(addsuffix /dev,$(LANGUAGES)))
-DEV_DOCS_TOCS = $(addprefix $(TOC_DIR)/,$(addsuffix _dev-src.yml, $(LANGUAGES)))
-
-# generated files
-VERSION_CONFIG    = $(CONFIG_DIR)/_version.yml
-DEFAULTS_CONFIG   = $(CONFIG_DIR)/_defaults.yml
-DOCS_VERSION_DATA = $(DATA_DIR)/docs-versions.yml
-DOCS_PAGE_LIST    = $(DATA_DIR)/all-pages.yml
-PLUGINS_APP       = $(PLUGINS_DEST_DIR)/plugins.js
-MAIN_STYLE_FILE   = $(CSS_DEST_DIR)/main.css
-
-STYLES = $(MAIN_STYLE_FILE) $(addsuffix .css,$(basename $(subst $(CSS_SRC_DIR),$(CSS_DEST_DIR),$(STYLES_SRC))))
-
-DOCS_VERSION_DIRS  = $(filter-out %.md,$(wildcard $(DOCS_DIR)/**/*))
-DOCS_VERSION_SLUGS = $(call slugify,$(subst $(DOCS_DIR)/,,$(DOCS_VERSION_DIRS)))
-TOC_FILES          = $(addprefix $(TOC_DIR)/,$(addsuffix -gen.yml,$(DOCS_VERSION_SLUGS)))
-
-FETCH_FLAGS   = --config $(FETCH_CONFIG) --docsRoot $(DOCS_DIR)
-FETCHED_FILES = $(shell $(NODE) $(FETCH_SCRIPT) $(FETCH_FLAGS) --dump)
-
-NEXT_DOCS      = $(addprefix $(DOCS_DIR)/,$(addsuffix /$(NEXT_DOCS_VERSION),$(LANGUAGES)))
-NEXT_DOCS_TOCS = $(addprefix $(TOC_DIR)/,$(addsuffix _$(NEXT_DOCS_VERSION_SLUG)-src.yml,
$(LANGUAGES)))
-
-# other variables
-# NOTE:
-#      the order of config files matters to Jekyll
-JEKYLL_CONFIGS = $(MAIN_CONFIG) $(DEFAULTS_CONFIG) $(VERSION_CONFIG)
-JEKYLL_FLAGS   =
-
-BUILD_DATA = $(TOC_FILES) $(DOCS_VERSION_DATA) $(DOCS_PAGE_LIST)
-
-# convenience targets
-help usage default:
-	@echo ""
-	@echo "Usage:"
-	@echo ""
-	@echo "    make build:      build site with dev config"
-	@echo "    make install:    install dependencies"
-	@echo ""
-	@echo "    make data:       generate data files (Generated ToCs, $(DOCS_VERSION_DATA), $(DOCS_PAGE_LIST))"
-	@echo "    make configs:    generate Jekyll configs ($(DEFAULTS_CONFIG), $(VERSION_CONFIG))"
-	@echo "    make styles:     generate CSS"
-	@echo "    make plugins:    generate plugins app ($(PLUGINS_APP))"
-	@echo ""
-	@echo "    make snapshot:   copy dev docs to $(LATEST_DOCS_VERSION) docs"
-	@echo "    make newversion: create $(NEXT_DOCS_VERSION) docs from dev docs"
-	@echo ""
-	@echo "    make clean:      remove all generated output"
-	@echo "    make nuke:       run 'make clean' and remove all dependencies"
-	@echo ""
-	@echo "Arguments:"
-	@echo ""
-	@echo "    NODOCS: (defined or undefined) - excludes docs from build"
-	@echo "    PROD:   (defined or undefined) - uses production config instead of dev config"
-	@echo ""
-
-fetch: $(FETCHED_FILES)
-data: $(BUILD_DATA)
-configs: $(DEFAULTS_CONFIG) $(VERSION_CONFIG)
-styles: $(STYLES)
-plugins: $(PLUGINS_APP)
-toc: $(TOC_FILES)
-
-ifdef PROD
-
-JEKYLL_CONFIGS += $(PROD_CONFIG)
-ifdef NODOCS
-$(error Cannot ignore docs during a production build)
-endif
-
-else
-
-JEKYLL_CONFIGS += $(DEV_CONFIG)
-JEKYLL_FLAGS += --trace
-ifdef NODOCS
-JEKYLL_CONFIGS += $(DOCS_EXCLUDE_CONFIG)
-endif
-
-endif
-
-build: JEKYLL_FLAGS += --config $(subst $(SPACE),$(COMMA),$(strip $(JEKYLL_CONFIGS)))
-build: $(JEKYLL_CONFIGS) $(FETCHED_FILES) $(BUILD_DATA) $(STYLES) $(PLUGINS_APP)
-	$(JEKYLL) build $(JEKYLL_FLAGS)
-
-install:
-	bundle install
-	npm install
-
-serve:
-	cd $(DEV_DIR) && python -m SimpleHTTPServer 8000
-
-# doing this in Make in a cross-platform way is pretty ugly
-snapshot: $(FETCHED_FILES)
-	$(GULP) snapshot
-
-newversion: $(NEXT_DOCS) $(NEXT_DOCS_TOCS)
-	echo $(NEXT_DOCS_VERSION) > $(VERSION_FILE)
-
-# real targets
-$(FETCHED_FILES): $(FETCH_CONFIG) $(FETCH_SCRIPT)
-	$(NODE) $(FETCH_SCRIPT) $(FETCH_FLAGS)
-
-# NOTE:
-#      the ">>" operator appends to a file in both CMD and SH
-$(PLUGINS_APP): $(PLUGINS_SRC)
-	echo ---> $@
-	echo --->> $@
-	$(BROWSERIFY) -t [ babelify --presets [ react ] --plugins [ transform-h-jsx ] ] -t envify
$< | $(UGLIFY) >> $@
-
-$(DOCS_VERSION_DATA): $(BIN_DIR)/gen_versions.js $(DOCS_DIR)
-	$(NODE) $(BIN_DIR)/gen_versions.js $(DOCS_DIR) > $@
-
-$(DOCS_PAGE_LIST): $(BIN_DIR)/gen_pages_dict.js $(FETCHED_FILES) $(REDIRECTS_FILE) $(SRC_DIR)
-	$(NODE) $(BIN_DIR)/gen_pages_dict.js \
-		--siteRoot $(SRC_DIR) \
-		--redirectsFile $(REDIRECTS_FILE) \
-		--latestVersion $(LATEST_DOCS_VERSION) \
-		--languages $(subst $(SPACE),$(COMMA),$(LANGUAGES)) \
-		> $@
-
-$(DEFAULTS_CONFIG): $(BIN_DIR)/gen_defaults.js $(VERSION_FILE) $(DOCS_DIR)
-	$(NODE) $(BIN_DIR)/gen_defaults.js $(DOCS_DIR) "$(LATEST_DOCS_VERSION)" > $@
-
-$(VERSION_CONFIG): $(VERSION_FILE)
-	sed -e "s/^/$(VERSION_VAR_NAME): /" < $< > $@
-
-$(MAIN_STYLE_FILE): $(SCSS_SRC)
-
-# pattern rules
-$(DOCS_DIR)/%/$(NEXT_DOCS_VERSION): $(DOCS_DIR)/%/dev
-	$(call copydir,$^,$@)
-ifndef WINDOWS
-	touch $(DOCS_DIR)
-endif
-
-$(TOC_DIR)/%_$(NEXT_DOCS_VERSION_SLUG)-src.yml: $(TOC_DIR)/%_dev-src.yml $(DOCS_DIR)
-	$(call copyfile,$<,$@)
-
-$(TOC_DIR)/%_dev-gen.yml: $(FETCHED_FILES)
-
-$(TOC_DIR)/%-gen.yml: $(TOC_DIR)/%-src.yml $(BIN_DIR)/augment_toc.js $(DOCS_DIR)
-	$(NODE) $(BIN_DIR)/augment_toc.js --srcToc $< --srcRoot $(DOCS_DIR)/$(call slug2language,$*)/$(call
slug2version,$*) > $@
-
-# NOTE:
-#      $(@D) means "directory part of target"
-$(CSS_DEST_DIR)/%.css: $(CSS_SRC_DIR)/%.less
-	-$(call makedir,$(@D))
-	echo ---> $@
-	echo --->> $@
-	$(LESSC) $< >> $@
-
-$(CSS_DEST_DIR)/%.css: $(CSS_SRC_DIR)/%.scss
-	-$(call makedir,$(@D))
-	echo ---> $@
-	echo --->> $@
-	$(SASSC) $< >> $@
-
-$(CSS_DEST_DIR)/%.css: $(CSS_SRC_DIR)/%.css
-	-$(call makedir,$(@D))
-	echo ---> $@
-	echo --->> $@
-	$(call printfile,$<) >> $@
-
-# maintenance
-clean:
-	$(call RM, $(VERSION_CONFIG))
-	$(call RM, $(DEFAULTS_CONFIG))
-	$(call RM, $(DOCS_PAGE_LIST))
-	$(call RM, $(DOCS_VERSION_DATA))
-	$(call RM, $(TOC_FILES))
-	$(call RM, $(PLUGINS_APP))
-	$(call RM, $(FETCHED_FILES))
-	-$(call RMDIR, $(CSS_DEST_DIR))
-	-$(call RMDIR, $(PROD_DIR))
-	-$(call RMDIR, $(DEV_DIR))
-
-nuke: clean
-	$(call RMDIR, node_modules)
-	$(call RM, Gemfile.lock)
-
-.PHONY: clean usage help default build fetch $(DEV_DOCS)
\ No newline at end of file
diff --git a/doc/installing-a-development-environment.md b/doc/installing-a-development-environment.md
index 56f6faebe..d4b7da340 100644
--- a/doc/installing-a-development-environment.md
+++ b/doc/installing-a-development-environment.md
@@ -4,8 +4,7 @@ The development environment setup requires installation of the following softwar
 
 1. Ruby - Needed by Jekyll. Jekyll is the static site generator that generates the website
and docs.
 1. Node.js - Needs to be installed in order to install all the required development and JavaScript
dependencies.
-1. Make - Can be installed in order to build Cordova website using Make. This installation
is optional.
-1. Python - Can be installed in order to invoke simple HTTP server from Make. This installation
is optional.
+1. Python - Neeeded by Jekyll dependencies like Pygments.
 
 ### Mac OS X
 
@@ -19,13 +18,7 @@ Install Homebrew from [this site][homebrew], and then run:
 
 Go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and
follow the on-screen instructions. Make sure that the option to **install NPM** is enabled,
if you see one.
 
-#### Make (optional)
-
-Make comes with the Xcode Command Line Tools. To install them, run:
-
-    xcode-select --install
-
-#### Python (optional)
+#### Python
 
 Mac OS X comes with Python 2.7 pre-installed. Else, follow these steps:
 
@@ -59,11 +52,7 @@ Follow these steps:
 
 Go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and
follow the on-screen instructions. Make sure that the option to **install NPM** is enabled,
if you see one.
 
-#### Make (optional)
-
-Make can be installed on Windows from [this page][make_page] by downloading the [setup tool][make_setup]
and running it.
-
-#### Python (optional)
+#### Python
 
 Follow these steps:
 
@@ -82,11 +71,7 @@ Run the commands from [this site][ruby_linux] that apply to your Linux
distribut
 
 Follow the instructions on [this site][linux_node].
 
-#### Make
-
-Make is installed by default on Linux.
-
-#### Python (optional)
+#### Python
 
 The latest version of CentOS, Fedora, Redhat Enterprise (RHEL) and Ubuntu come with Python
2.7 pre-installed. Else, follow the steps from [this site][python_linux].
 
@@ -107,12 +92,6 @@ Verify your Node.js installation by running:
     node --version
     npm --version
 
-#### Verify make
-
-Verify your make installation by running:
-
-    make --version
-
 #### Verify Python
 
 Python 2.7 is also required to build the docs. NOTE: *The docs will not build with Python
3.0 or greater.*
@@ -179,7 +158,5 @@ You could try a different method to install Ruby. Checkout [rbenv](https://githu
 [python_installer_mac]: https://www.python.org/ftp/python/2.7.11/python-2.7.11-macosx10.6.pkg
 [python_installer_windows]: https://www.python.org/ftp/python/2.7.11/python-2.7.11.amd64.msi
 [python_linux]: http://docs.python-guide.org/en/latest/starting/install/linux/
-[make_page]: http://gnuwin32.sourceforge.net/packages/make.htm
-[make_setup]: http://gnuwin32.sourceforge.net/downlinks/make.php
 [cordova-docs]: https://github.com/apache/cordova-docs
 [GlobalSignRootCerficateAuthority]: https://raw.githubusercontent.com/rubygems/rubygems/master/lib/rubygems/ssl_certs/index.rubygems.org/GlobalSignRootCA.pem
\ No newline at end of file


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> No mention of 'Make' command running in 'developing-the-website' section
> ------------------------------------------------------------------------
>
>                 Key: CB-13955
>                 URL: https://issues.apache.org/jira/browse/CB-13955
>             Project: Apache Cordova
>          Issue Type: Bug
>          Components: cordova-docs
>            Reporter: Gandhirajan
>            Assignee: Gandhirajan
>            Priority: Major
>
> Only 'Make' installation step is mentioned in the doc. But there no mention of 'Make'
command running in 'developing-the-website' section of cordova docs.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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


Mime
View raw message