[
https://issues.apache.org/jira/browse/NETBEANS-124?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16256479#comment-16256479
]
Wade Chandler commented on NETBEANS-124:
----------------------------------------
As it relates to platform, kb, and community, the following lists the file
counts of particular types. The .inc.html and/or .inc.htm files are included in
the .html and .htm file counts, but should be excluded or worked into the
content in some way by the script as they are part of the content displayed on
the current site, but must be embedded in the actual content or a template for
the SSG to work properly. These will have to be investigated 1 by 1 to
determine the case. It is likely if the same named HTML file represents a
section, then the file could be merged into a template, but if the same named
file represents some standalone file, then it must be worked into the content.
Luckily there do not seem to be too many inc files to examine manually.
File counts:
platform/*.html 1548
platform/*.htm 1
platform/*.inc.html 0
platform/*.inc.htm 0
community/*.html 2079
community/*.htm 1
community/*.inc.html 63
community/*.inc.html 0
kb/*.html 1480
kb/*.htm 0
kb/*.inc.html 9
kb/*.inc.html 0
> Create Groovy script to generated required YAML side car files (meta-data)
> for content, and strip content from old site files
> -----------------------------------------------------------------------------------------------------------------------------
>
> Key: NETBEANS-124
> URL: https://issues.apache.org/jira/browse/NETBEANS-124
> Project: NetBeans
> Issue Type: Task
> Components: website
> Reporter: Wade Chandler
>
> The new NetBeans statically generated website being developed at
> https://github.com/wadechandler/netbeans-static-site uses JBake and Gradle to
> build the site. It uses certain YAML files as "sidecar" files to the content
> files which explain to a template the type of file it is along with other
> meta-data, such as the document title etc. The new site uses Groovy templates
> to allow for common headers, footers, and side bars.
> These sidecar files, along with the main body content, allow for templates to
> be matched to the content type of a file, and then for that file to have
> everything it requires embedded inside of it to be served as a "static" web
> site with no server side component dynamically binding the information at
> runtime. This is a requirement of Apache projects web sites; to be static.
> The Groovy script described in this issue will:
> * Pull information such as the title, keywords, description, and other
> meta-data which may be embedded in HTML or other file types, and place that
> into the required sidecar YAML files of the build system
> * Pull out the main body content from the the original HTML file and place it
> into a file of the same name to match the YAML sidecar file per the new site
> naming conventions (see the README.md file)
> * Choose a template type for the content based on its file system hierarchy
> which seems representative of the way current NetBeans website is laid out;
> notice depending on the drill down into the web site, that certain side bars,
> headers, etc differ or are enabled or disabled. The new site does this based
> on the page/template type
> This Groovy script is a development time tool which is used to transform the
> old content into the format now needed. Once the conversion is done, then it
> should no longer be needed. It will be able to be run from the Gradle build
> like other aspects of the new sites build system; see buildSrc which is a
> good place for this Groovy script to be placed as a Groovy class.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
