cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jan Piotrowski (Sujan) (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CB-13339) Improve "Introduction" in README
Date Tue, 26 Sep 2017 15:56:02 GMT

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

Jan Piotrowski (Sujan) commented on CB-13339:
---------------------------------------------

First super rough draft:

{quote}This repository contains the source code for the \[Cordova website](cordova.apache.org).


The site is a static site build with \[Jekyll](http://jekyllrb.com/). It contains the homepage
and subpages, the \[blog](cordova.apache.org/blog) and the \[docs](cordova.apache.org/docs).
The \[plugin search](cordova.apache.org/plugins) is an embedded PreactJS (???) application.

The code of the actual site is located in \[`www`](www) with its subfolder \[docs](www/docs),
\[blog](www/blog) and \[plugins](www/plugins). Some additional content is \[pulled in during
the build process]().

It is built using a \[*gulp* script](gulpfile.js) that is run by *Node.JS*. *Jekyll* requires
*ruby* and is installed as one of the dependencies. (Alternatively you can build the site
using *Make*)

The site is also reachable with the "short" domain \[cordova.io](cordova.io), the important
subareas as \[docs.cordova.io](docs.cordova.io), \[blog.cordova.io](blog.cordova.io) and \[plugins.cordova.io](plugins.cordova.io).

The documentation is also translated into multiple languages. Read \[doc/translate.md](doc/translate.md)
to learn more.{quote}

Thoughts?

> Improve "Introduction" in README
> --------------------------------
>
>                 Key: CB-13339
>                 URL: https://issues.apache.org/jira/browse/CB-13339
>             Project: Apache Cordova
>          Issue Type: Sub-task
>          Components: cordova-docs
>            Reporter: Jan Piotrowski (Sujan)
>            Assignee: Jan Piotrowski (Sujan)
>
> Current content:
> {quote}This repository contains the source code for the Cordova website. This covers
cordova.io (= cordova.apache.org) and its subdomains docs.cordova.io (= cordova.apache.org/docs)
and plugins.cordova.io (= cordova.apache.org/plugins).{quote}



--
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